This is the sourcecode for haxeflixel.com. It is made with a nodejs static site generator called DocPad. You can compile this website yourself with a local install of Docpad, pull requests are welcome.
-
Clone and run the server
git clone https://github.com/HaxeFlixel/haxeflixel.com.git cd haxeflixel.com
To install dependencies and run docpad, run the following commands:
npm install docpad run
Or if you are a windows user:
...run
install.bat
, thenrun.bat
-
Start hacking away by modifying the
src
directory, the live reload plugin will compile the site as you save the files you modify.
How to add Documentation
Documentation is being pulled periodically from the flixel-docs repository, please review the readme there for more info.
How to add a demo
-
Create a
.html.md
file in/src/documents/demos
following this example:``` title: "Demo-Name" layout: demo pageOrder: 1 SWFHeight: 480 SWFWidth: 640 source: "flixel-demos-subdirectory/Demo-Name" ``` Here goes the actual description of the demo in GitHub-Flavored-Markdown: * What the demo displays * Who created it * What the controls are * etc HTML is still allowed and can be used for more advanced descriptions.
source
points to the subdirectory of flixel-demos that contains the demo.
-
Add a screenshot of the demo named
Demo-Name.png
to/src/files/demos/images
. -
Add the actual swf file of the demo named
Demo-Name.swf
to/src/files/demos/swf
. Should be compiled withFLX_NO_DEBUG
(to show the flixel splash screen) and in release mode if possible!
How to a Showcase Item
-
Create a
.md
file in/src/documents/showcase
following this example:``` layout: "showcase" title: "BOSSES FOREVER 2.BRO" flash: true windows: true ouya: true mac: true website: "http://www.bossesforever.com/" ```
Note that by setting a target to true on one of the supported targets, the icon will automatically become coloured on the showcase page.
-
Add a screenshot of the showcase using the same title used in the
*.md
file, e.g.BOSSES FOREVER 2.BRO.png
to/src/files/showcase/images
. They are resized and cropped to 500x260, so it's best to use the same ratio.
Showcases that are not officially released yet are only accepted in special cases.