Skip to content

API Documentation for all of Mollie's public APIs.

Notifications You must be signed in to change notification settings

sjorssnoeren/api-documentation

Repository files navigation

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.

Contribute

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.

Prerequisites

  • Python > 2.7.9
  • Node > 9.x

Running locally

Download a copy of this repository:

git clone git@github.com:mollie/api-documentation.git

Then visit the downloaded repository and install dependencies:

cd api-documentation
make install

Generate docs

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

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.

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.

License

The project is licensed under the MIT license.

About

API Documentation for all of Mollie's public APIs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published