Website source for docs.oc.tc. Uses the ruby on rails staticmatic gem to build a static documentation website.
Pull requests should have the following things:
-
The commits should have a descriptive message and which is not in the past tense.
For example:
Describe the XYZ module with more detail.
orAdd detailed description for XYZ.
is good, but:Added XYZ.
isn't. -
Content should be grammatically correct and the spelling should be US English, e.g. Color not Colour.
- Install ruby, ruby on rails and bundle
- Run
bundle install
from the source root. - Run
staticmatic preview
orbundle exec staticmatic preview
- Load
localhost:4000
in your browser.