flixel | addons | ui | demos | tools | templates | docs | haxeflixel.com
This is the main location for HaxeFlixel documentation. Pull requests from this location will be pushed to the live website periodically, so please help us improve the HaxeFlixel docs.
- The "main" documentation available on haxeflixel.com/documentation.
- The API documentation.
The main documentation is made up of *.html.md files in the ./documentation folder. Each file and folder starts with a numerical prefix specifying the order listed on the docpad website.
Additional pages can be added using the same extension and using a header specifying the title as seen in the other pages. Eg:
---
title: "Documentation Page"
---
Use Regular GitHub flavoured markdown for the page.
Note `title:` above is case sensitive.
The markdown syntax used in the docs is the GitHub-Flavored-Markdown, thus it's very convenient to directly edit the files via GitHub's web editor.
API documentation is provided in the ./api folder, they are currently generated with dox. You can view the API docs offline by cloning this directory, checking out the gh-pages branch, running nekotools server in ./api and navigating to localhost:2000.
To generate the API docs yourself, you need to first run npm install in api/dox. Then run the following from the root directory:
haxe --cwd api --run Make xml pages server
The docs will now be generated in the api/dox/out folder and a local webserver started at localhost:2000.
Note this will use your locally enabled haxelib flixel versions, e.g. if you have haxelib git flixel set to dev etc.