haxejs
haxejs copied to clipboard
Documentation about using JavaScript with Haxe
Haxe and JavaScript
There used to be a website (an old one, from when Haxe spelled "haXe") that got you started.
But that is no more. I decided to get some of that back. Based upon the information from the old site and my own need to document this.
Visit http://matthijskamstra.github.io/haxejs/
How to contribute?
Read more about that here. But it boils down to: JUST DO IT!
Visit https://github.com/MatthijsKamstra/haxejs to modify the "source" aka markdown files.
Found any "bug" or have a great idea? Please create a new issue.
How to build?
I will be using Gitbook to export to static html
.
You need to install Node.js and then you automatically have NPM:
Install gitbook
npm install gitbook-cli -g
or if you have gitbook installed, update it
gitbook update
I wanted to make the editing of these file as-easy-as-possible. This gitbook plugin helps with that: gitbook plugin edit link. And if all fails, I used Disqus comments on your books to add comments at the bottom of each page.
Activate the plugins with:
gitbook install
Export everything to html
gitbook build
NPM build
I created a little script with NPM to make my life somewhat easier:
npm run gitbook
Will install and update gitbook
npm run build
Will remove old docs
- and _book
-folder, build new gitbook and rename _book
- to docs
-folder.
npm run deploy
Will just push everything without consideration
What is Gitbook?
I will be using gitbook to generate the website.
Primarily reason for this: I have never used it, it uses markdown as input files and it also generates a static html
site.
What is Markdown
A familiar way to write documentation for developers.
This should make it easier to contribute!
Markdown is a plain text formatting syntax created by John Gruber, aiming to provide a easy-to-read and feasible markup. You can find the original Markdown syntax specification here.
MacDown is a simple-to-use editor for Markdown documents. It renders your Markdown contents real-time into HTML, and display them in a preview panel. You can download it here.
Original haxejs.org
You can find the original data with WayBack Machine