Giter Club home page Giter Club logo

jme3-wiki's Introduction

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.

jme3-wiki's People

Contributors

mitm001 avatar ali-rs avatar davidb avatar jmecn avatar quazi-irfan avatar neph1 avatar sprinter-17 avatar 8keep avatar shadowislord avatar stephengold avatar nehon avatar ertugrulcetin avatar dgc9crew avatar rootli avatar uaequals42 avatar oilboi avatar osrepnay avatar nemesismate avatar beardeddragon5 avatar jayfella avatar takahawk avatar ia97lies avatar grizeldi avatar failfarm avatar empirephoenix avatar dependabot[bot] avatar tonedef71 avatar mrlem avatar riccardobl avatar rsubtil avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.