wiki

wiki copied to clipboard

= jMonkeyEngine Documentation

image:https://github.com/jMonkeyEngine/wiki/workflows/Build%20Docs/badge.svg[Status Badge, 175, 25]

see link:https://wiki.jmonkeyengine.org[https://wiki.jmonkeyengine.org/]

The project to store, edit, and generate the documentation of http://jmonkeyengine.org[jMonkeyEngine].

The documentation docs/modules/ROOT/pages is editable :

• Online via github (Edit link located on the top navbar of the Wiki + Pull Request)
• Offline with the Atom editor, which includes a built in previewer and code editor. see link:https://wiki.jmonkeyengine.org/docs-wiki/3.4/atom_editor.html[Atom Editor for Wiki Editing]
• Any text editor and browser program of your choice.
• Setting up your own local Node.js environment.

NOTE: Read the link:https://wiki.jmonkeyengine.org/docs-wiki/3.4/wiki_contributor.html[Wiki Contributions] document for details on how to contribute.

== Build & Preview

To set up the Antora environment, you'll need Nodejs (tested with node 12).

From your local wiki directory.

Run:

npm install
npm run buildDocs

This will install the needed dependencies and run the static site generator. The documentation will be output to the directory build/site.

To preview, navigate to the build/site directory and open the index.html file in your browser.

See also: https://docs.antora.org/antora/2.3/preview-site/