Contributing

This project is an ongoing work, and we need your help. li3 users new and old are welcome and encouraged to join in the fun. If you’ve struggled with something, help us record and share the solution so others can find the way more easily. There are many ways you can help:

  • Code examples to enrich current documentation
  • Do lists or tables to help explain concepts
  • Rough notes that describe an oft-used process
  • Corrections (typos, inaccuracies, etc.)
  • Translations

If you’d like to help, simply fork the project on GitHub, open a new issue, or get in contact with one of the core team members. You can give us a shout in channel #li3 on server Freenode, or send an email to anderson.johnd at gmail dot com.

Markup

We’re using GitHub markdown to render the final documents.

Notes

You add notes using the following markup:

  1. <div class="note note-info">
  2.     Informational note here.
  3. </div>

There are 3 classes of notes caution (class is note-caution), informational (note-info)
and hints/tips (note-hint). Any code inside the divs will need to be marked up manually using
<code></code> tags.

Versions

There will be no separate manuals for minor versions. Instead features available only
in since certain versions are documented as follows:

  1. <div class="note note-version">This feature is available with version 1.1.</div>

Code

Use tabs to indent the code inside fenced code blocks. This allows us to adjust the spacing when rendering and highlighting the code.

Language hints may be used for snippets - where its hard to detect the language automatically.