Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matthijskamstra/haxephp
Documentation Haxe and PHP
https://github.com/matthijskamstra/haxephp
haxe php
Last synced: about 3 hours ago
JSON representation
Documentation Haxe and PHP
- Host: GitHub
- URL: https://github.com/matthijskamstra/haxephp
- Owner: MatthijsKamstra
- License: mit
- Created: 2015-09-01T20:03:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T10:11:26.000Z (about 1 year ago)
- Last Synced: 2024-04-16T21:24:54.461Z (9 months ago)
- Topics: haxe, php
- Language: Haxe
- Homepage: http://matthijskamstra.github.io/haxephp/
- Size: 4.44 MB
- Stars: 7
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Haxe and PHP
There is not a lot of information about Haxe and PHP. I decided to do something about that.
#### Visit [http://matthijskamstra.github.io/haxephp/](http://matthijskamstra.github.io/haxephp/)
## How to contribute?
Read more about that [here](contribute.md).
But it boils down to: **JUST DO IT!**
#### Visit [https://github.com/MatthijsKamstra/haxephp](https://github.com/MatthijsKamstra/haxephp) to change the "source" aka markdown files.
Found any "bug" or have a great idea? Please create a [new issue](https://github.com/MatthijsKamstra/haxephp/issues/new).
## How to build?
I will be using [Gitbook](https://github.com/GitbookIO/gitbook#how-to-use-it) to export to static `html`.
You need to install Node.js and then you automatically have NPM:
Install gitbook
```bash
npm install gitbook-cli -g
```
or if you have gitbook installed, update it
```bash
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](https://www.npmjs.com/package/gitbook-plugin-edit-link).
And if all fails, I used [Disqus comments on your books](https://github.com/GitbookIO/plugin-disqus) to add comments at the bottom of each page.
Activate the plugins with:
```bash
gitbook install
```
Export everything to `html`
```bash
gitbook build
```
---
## NPM build
I created a little script with NPM to make my life somewhat easier:
```bash
npm run gitbook
```
Will install and update gitbook
```bash
npm run build
```
Will remove old `docs`- and `_book`-folder, build new gitbook and rename `_book`- to `docs`-folder.
```bash
npm run deploy
```
Will just push everything without consideration
### What is Gitbook?
I will be using [gitbook](https://github.com/GitbookIO/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](http://daringfireball.net/projects/markdown/syntax).
**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](http://macdown.uranusjr.com/).