Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.34 KB

README.adoc

File metadata and controls

34 lines (21 loc) · 1.34 KB
Raw

jMonkeyEngine Documentation

Status Badge

The project to store, edit, and generate the documentation of 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 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 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.