Guide and reference documentation for the 0.1.x release of Elefrant. Content for most sections on the Elefrant website is compiled from here. In some cases, the markdown files are split, relinked, converted to HTML, or formatted to fit within the skin of elefrant.com- but most of the time, a .md
file in this repo corresponds one-to-one with a client-side route on the website (e.g. /#/documentation/reference/Blueprints/Create.html
).
We welcome your help! Please send a pull request to master with corrections/additions and they'll be double-checked and merged as soon as possible.
Secondly, we are open to suggestions about the process we're using to manage our documentation, and to work with the community in general. Please post to the
with your ideas- or if you're interested in helping directly, contact @marsanla on Twitter.
Currently, these docs are pushed almost instantaneously to elefrant.com. That will likely continue to happen for the forseeable future.
However, when v0.1.0 is released as "stable", docs will also be compiled and pushed to http://elefrant.com every time a new stable release of Elefrant is published to npm. In general, this repo should follow the same versioning strategy as Elefrant (using tags).