The guide to Easy Dynamics GitHub repositories is a GitHub Pages project that helps visitors and contributors navigate software projects at Easy Dynamics. The purpose of this readme is to orient contributors of this repository. If you're new to software development at Easy Dynamics, please visit the published version of this guide at easydynamics.github.io to learn more about the procedures and how to get started with contributing.
- Ruby version 2.4.0 or higher.
- RubyGems this might already be included in the Ruby download based what you downloaded and installed.
- Jekyll see step 7 onwards.
- Visual Studio Code preferred but not required for conducting development in an IDE.
This project is a Jekyll site that uses a remote theme from Just the Docs, and is hosted on GitHub Pages. The pages are primarily developed in Markdown and proceessed via kramdown. Customization to the themes and layouts are done with SCSS and HTML. Most of the high level configuration can be found in _config.yml and is a mix of configuration from Jekyll and Just the Docs. To learn more about how to create and organize content refer to Jekyll Docs. To customize the layout and theme, refer to the appropriate section under Just the Docs - Customization.
Test the site locally by running the following command:
$ bundle exec jekyll serve --watch
Once the server is up and running, visit http://localhost:4000 in a browser to validate the layout and content. The --watch flag allows you to change content without having to stop and restart the server (live reload).
If you notice a bug or want to report an issue with easydynamics.github.io, see if it's related to any of the existing ones and join the conversation. If not, open a new issue and describe it for us. If you want to fix minor bugs or issues, feel free to open a pull request with the appropriate changes. For broader topics, start a conversation on an issue and build consensus with the maintainers before creating a pull request. Last but not least, please follow GitHub Community Guidelines.