Mollie public API documentation
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.
The documentation is formatted using reStructuredText. Additionally, we use a Sphinx extension to help format tables.
Contribute
We take pull requests from anyone on our documentation, if you think that something can be improved please open a PR.
All documentation should be written in US English.
If you are a Mollie employee, please don't include any links to internal issue trackers or other internal applications in your PR or issue description, API examples or commit messages.
Note that PhpStorm comes with a reStructuredText plugin. You can enable it from the Plugins preferences pane. It enables some syntax highlighting.
Prerequisites
python3
(must be in your$PATH
, usebrew install python3
)- pip, Python's package manager. Installation instructions.
- Node > 12.x. Installation using the Node Version Manager is recommended.
Running locally
Create a fork, or clone this repository if you have write access:
git clone git@github.com:mollie/api-documentation.git
Then visit the downloaded repository and install dependencies:
cd api-documentation
make install
Generate HTML and supporting files
Finally, build the documentation, its CSS and JS files by running:
make html
You can now preview the generated documentation by opening build/html/index.html
:
open build/html/index.html
Making changes to copy
After running make html
at least once, you can use make html-only
to quickly update the HTML files if you changed
some copy. This way, you can have a quick REPL.
$ make html-only
Running Sphinx v1.7.1
...
updating environment: 0 added, 2 changed, 0 removed
...
build succeeded.
The HTML pages are in build/html.
$ open build/html/index.html
Sphinx will only update files for which the source files have changed.
Styling docs
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.
Most of the graphics used throughout the docs can be found in our (employees only) Figma account.
Releasing new versions of the documentation
Deployment is handled using continuous deployment via Travis CI.
Successful builds on the master
branch will be automatically deployed.
Support
If you are having issues, please let us know. We accept pull requests on our public documentation.
You can get support via info@mollie.com.
Working at Mollie
Mollie is always looking for new talent to join our teams. We are looking for inquisitive minds with good ideas and strong opinions, and, most importantly, who know how to ship great products. Want to join the future of payments? Check out our vacancies.
License
The documentation is licensed under the CC BY-SA 4.0 license.