https://github.com/jmonkeyengine/wiki

The official wiki for jMonkeyEngine.
https://github.com/jmonkeyengine/wiki

hacktoberfest jmonkeyengine

Last synced: 4 months ago
JSON representation

The official wiki for jMonkeyEngine.

• Host: GitHub
• URL: https://github.com/jmonkeyengine/wiki
• Owner: jMonkeyEngine
• License: bsd-3-clause
• Created: 2016-06-12T20:23:03.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-29T17:05:23.000Z (almost 2 years ago)
• Last Synced: 2024-05-23T01:26:21.321Z (over 1 year ago)
• Topics: hacktoberfest, jmonkeyengine
• Language: Handlebars
• Homepage: https://wiki.jmonkeyengine.org
• Size: 290 MB
• Stars: 28
• Watchers: 25
• Forks: 62
• Open Issues: 10
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= 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.8/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.8/wiki_contributor.html[Wiki Contributions] document for details on how to contribute.

== Build & Preview

To set up the Antora environment, you'll need Node.js and Nvm.

From your local wiki directory, run:

```

npm install

npx antora wiki-playbook.yml

```

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/