The official wiki for jMonkeyEngine.
David Bernard
bff1883b06
templates: quick work to add edit/create button in generated html pages
|
9 年之前 | |
|---|---|---|
| gradle | 9 年之前 | |
| src | 9 年之前 | |
| .editorconfig | 9 年之前 | |
| .gitignore | 9 年之前 | |
| .travis.yml | 9 年之前 | |
| README.adoc | 9 年之前 | |
| build.gradle | 9 年之前 | |
| deploy_ghpages.sh | 9 年之前 | |
| gradlew | 9 年之前 | |
| gradlew.bat | 9 年之前 |
README.adoc
image:https://travis-ci.org/jMonkeyEngine/wiki.svg?branch=master["Build Status", link="https://travis-ci.org/jMonkeyEngine/wiki"]
= 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 (<>) 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
- [x] configure travis build
- [x] configure github + gradle + travis to publish on gh-pages branches
- [x] find and fixe conversion bug
- [x] complete conversion: note, warning, ...
- [ ] fix warning during html's generation (should be fixed manually)
- [x] add meta info during conversion (doctitle, revision, tags, ...)
- [x] add a home page (index.html)
- [ ] add a navigation bar or a menu (?)
- [ ] customize html layout (header, footer, css)
- [x] 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
= 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 (<>) 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
- [x] configure travis build
- [x] configure github + gradle + travis to publish on gh-pages branches
- [x] find and fixe conversion bug
- [x] complete conversion: note, warning, ...
- [ ] fix warning during html's generation (should be fixed manually)
- [x] add meta info during conversion (doctitle, revision, tags, ...)
- [x] add a home page (index.html)
- [ ] add a navigation bar or a menu (?)
- [ ] customize html layout (header, footer, css)
- [x] 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