This project contains the source of all of Mollie's public API documentation. The full documentation (in an easy to use format) may be found at https://docs.mollie.com.
We take pull requests on our documentation as well, if you think that something can be improved please open a PR.
The documentation is formatted using reStructuredText. All documentation should be written in US English.
Note that PhpStorm comes with a reStructuredText plugin. You can enable it from the Plugins preferences pane. It enables some syntax highlighting.
- Python > 2.7.9
- Node > 9.x
Download a copy of this repository:
git clone [email protected]:mollie/api-documentation.git
Then visit the downloaded repository and install dependencies:
cd api-documentation
make install
Finally, build the documentation, its CSS and JS files by running:
make html
You can now preview the docs by opening build/html/index.html
:
open build/html/index.html
You can make changes to the styling by starting a web server locally:
make start
Visit http://localhost:8000 to preview your changes. CSS & JS changes will appear without the need to refresh your browser.
If you are having issues, please let us know. We accept pull requests on our public documentation.
You can get support via [email protected].
The project is licensed under the MIT license.