Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
50 lines (42 sloc) 1.69 KB
---
title: Website Design
layout: default
---
Please refer to the <a
href="/doxygen/html/md_CONTRIBUTING.html">contributing guidelines</a> for
the general flow of this project and procedure for sending pull
requests.</p>
The website is generated using <a
href="https://jekyllrb.com/">jekyll</a> and <a
href="http://www.doxygen.nl/">Doxygen</a>.
<h3>jekyll</h3>
<p>
The site is published from the <a
href="https://github.com/theimpossibleastronaut/rmw/tree/master/docs">docs/
directory</a> using <a href="https://pages.github.com/">GitHub
pages</a>. The frameworks used are <a
href="https://www.w3schools.com/w3css/default.asp">W3.CSS</a> and <a
href="https://fontawesome.com/">Font Awesome</a>.
</p>
<h4>Code style</h4>
<p>
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.
<h3>Doxygen</h3>
<p>
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).
</p>
<p>
The doxygen pages are published from docs/doxygen/html and are
periodically generated by the project maintainers.
</p>