Contributing¶
Please have a look at CONTRIBUTING.md.
Building the documentation¶
The documentation for PortPHP is created using MkDocs, a lightweight solution based on Markdown.
The documentation is hosted on Read the Docs. To build the documentation on your local machine, clone the repository and install the dependencies:
$ git clone https://github.com/portphp/portphp.git
$ cd portphp
$ pip install -r docs/requirements.txt
Then run a live server:
$ mkdocs serve
And open http://127.0.0.1:8000
in your browser.