jMonkeyEngine Documentation

Warning

The project is an experimental WIP for the documentation of jME3

see http://jmonkeyengine.github.io/wiki/documentation

The project to store, edit, and generate the documentation of jMonkeyEngine

The documentation ([src/docs/asciidoc]) is editable :

• online via github (Edit button + PR)

• offline, after local git clone + …​.

The syntax is asciidoc :

• Asciidoc Syntax Quick Reference

Contribute

TODO

Build

Convert the AsciiDoc to HTML5 by invoking the 'asciidoctor' goal:

$ ./gradlew asciidoctor

Open the file build/asciidoc/html5/index.html in your browser to see the generated HTML file.

TODO

==

• ✓ configure travis build

• ✓ configure github + gradle + travis to publish on gh-pages branches

• ✓ find and fixe conversion bug

• ✓ complete conversion: note, warning, …​

• ❏ fix warning during html’s generation (should be fixed manually)

• ✓ add meta info during conversion (doctitle, revision, tags, …​)

• ✓ add a home page (index.html)

• ❏ add a navigation bar or a menu (?)

• ❏ customize html layout (header, footer, css)

• ✓ transfer ownership to jMonkeyEngine org

• ❏ complete Doc, how to contribute,…​

• ❏ accept PR

• ❏ write a post about the migration (the tools, why asciidoc, vs alternatives, how …​)

• ❏ generate sitemap

• ❏ add search box

• ❏ add google analytics (?)

• ❏ support emoji

• ❏ support iframe block

• ❏ fix slideshow of "Xxx for Dummies"

• ❏ optimize remove useless images

• ❏ optimize image, use smaller file, eg convert to jpg or to webp, resize

• ❏ organize i18n / lang

• ❏ use tags to create taxonomy