| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 |
- = 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 http://jmonkeyengine.org[jMonkeyEngine]
- The documentation (<<src/docs/asciidoc>>) is editable :
- * online via github (Edit button + PR)
- * offline, after local `git clone` + ....
- The syntax is asciidoc :
- * http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[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
- - [ ] 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, ...)
- - [ ] generate sitemap
- - [ ] add search box
- - [ ] add google analytics (?)
- - [ ] support emoji
- - [ ] optimize remove useless images
- - [ ] optimize image, use smaller file, eg convert to jpg or to webp, resize
|
