https://github.com/haxeflixel/flixel-docs

Documentation for HaxeFlixel
https://github.com/haxeflixel/flixel-docs

api api-documentation documentation dox haxeflixel

Last synced: 4 days ago
JSON representation

Documentation for HaxeFlixel

• Host: GitHub
• URL: https://github.com/haxeflixel/flixel-docs
• Owner: HaxeFlixel
• Created: 2013-12-30T03:17:53.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T16:27:42.000Z (3 months ago)
• Last Synced: 2024-10-30T02:58:19.974Z (16 days ago)
• Topics: api, api-documentation, documentation, dox, haxeflixel
• Language: CSS
• Homepage:
• Size: 51.6 MB
• Stars: 72
• Watchers: 7
• Forks: 134
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![](https://raw.github.com/HaxeFlixel/haxeflixel.com/master/src/files/images/flixel-logos/flixel-docs.png)

[flixel](https://github.com/HaxeFlixel/flixel) | [addons](https://github.com/HaxeFlixel/flixel-addons) | [ui](https://github.com/HaxeFlixel/flixel-ui) | [demos](https://github.com/HaxeFlixel/flixel-demos) | [tools](https://github.com/HaxeFlixel/flixel-tools) | [templates](https://github.com/HaxeFlixel/flixel-templates) | [docs](https://github.com/HaxeFlixel/flixel-docs) | [haxeflixel.com](https://github.com/HaxeFlixel/haxeflixel.com)

[![CI](https://img.shields.io/github/actions/workflow/status/HaxeFlixel/flixel-docs/main.yml?branch=master&logo=github)](https://github.com/HaxeFlixel/flixel-docs/actions?query=workflow%3ACI)

## About

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.

## Contents

* The "main" documentation available on [haxeflixel.com/documentation](https://haxeflixel.com/documentation).

* The API documentation.

### Main 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](https://github.com/HaxeFlixel/haxeflixel.com).

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](https://help.github.com/articles/github-flavored-markdown), thus it's very convenient to directly edit the files via GitHub's web editor. 

### API documentation

	

API documentation is provided in the `./api` folder, they are currently generated with [dox](https://github.com/HaxeFoundation/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](http://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.