Hi,
Ever fancied yourself a contributor to free software? Well now is your chance.
By contributing to the Coronium documentation, you ensure an up to date and user oriented guide to help newcomers and old-timers alike.
It’s pretty easy to do:
-
Clone the docs repo here: https://bitbucket.org/develephant/coronium-cloud-docs
-
Hack it up. Add more examples. Clarify issues. Rearrange. And then send a pull request.
-
Changes get merged in and you’ve officially contributed to free software! (high-five)
-
You’ll be credited in the docs, with an out-bound link of your choice.
“Style Guide” / Development
The Coronium docs are written in Markdown (GitHub styled), and built with MkDocs. Once pushed to the repo, the docs are consumed by readthedocs.org for display.
MkDocs provides a local server to display your work in realtime, and is useful when editing, though optional.
The docs use the admonition plugin for callouts. Browse the current Coronium docs source for more detailed usage examples.
For code highlighting the fenced code blocks plugin is used. You can see it in action in the Coronium docs source (using the GitHub style backticks), and allows for Lua, HTML, shell, and other language types.
If you’re looking to do some serious rearranging, take a look at the mkdocs.yml file at the root.
If you have any questions feel free to post them.
Cheers.