Thanks to the great works of Aurel everyone can now edit just markdown files to contribute to the Haxe Manual!
In the old setup we used LaTeX, which was converted to markdown for the website generator so the conversion step is easier for us now. Also, some users found LaTeX confusing so we removed this friction.
Take a look at the README.md of the HaxeManual to get the fine details about the structure and how to deal with links, sections, labels, code blocks, etc.
Contribute by doing a pull request
- Clone the HaxeFoundation/HaxeManual repository https://github.com/HaxeFoundation/HaxeManual.git
- Navigate to the
- Pick the markdown file and edit it.
- Make a fork of the HaxeManual, push your changes to a new branch on your fork
- Do a pull request
Contribute from the website
NOTE: at the moment of writing, this doesn’t work on haxe.org but soon will
Even easier is to use edit using the GitHub website, it has build-in markdown preview.
- Each page in the manual has this link, press it!
- Press the edit button on GitHub
- Edit the documentation and press “Propose File Change”
Alternative ways of contributing to the manual
Contributing doesn’t always mean you have to do the hard part of writing text. Helping spotting incorrect/missing parts content is very useful too.
- You can always open an issue here https://github.com/HaxeFoundation/HaxeManual/issues
- Or leave a comment on the documentation page itself. (These comments are all converted to issues on HaxeFoundation/haxe.org-comments so you can Watch that if you are curious)
We believe that this change should encourage Haxe users to make changes more easily and hope you help on the open source Haxe eco system too.