rmw (Remove to Waste)

Website Design

Please refer to the contributing guidelines for the general flow of this project and procedure for sending pull requests.

The website is generated using jekyll and Doxygen.

jekyll

The site is published from the docs/ directory using GitHub pages. The frameworks used are W3.CSS and Font Awesome.

Code style

Try to be as consistent as possible. When using Jekyll, the html is sometimes split across several files so it can be challenging to get perfect indentation. The general rule is 2 space indentation; however, right now we have no regular web devs working on this project, so if you would like to recommend another style or have other suggestions regarding the website, please let us know by opening an issue for discussion.

Markdown

Much of the jekyll part of the web site uses GitHub markdown. For certain areas where style is applied, html is used.

Doxygen

Doxygen is primarily used on this project to generate documentation for C developers. Presently we are using the default style and design that doxygen provides. Most web devs who work on this project will not need to do anything related to the doxygen-generated pages. In the future, we may decide to make changes and modify the default layout (If that interests you, let us know).

The doxygen pages are published from docs/doxygen/html and are periodically generated by Andy.

 Edit or Improve this page

Valid XHTML 1.0!

Powered by jekyll