Code Monkey home page Code Monkey logo

api-documentation's Introduction

Mollie public API documentation

Greenkeeper badge

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 (with pip to install dependencies)
  • Node > 9.x

Running locally

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

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 [email protected].

Working at Mollie

Mollie is always looking for new talent to join our teams. We’re 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.

api-documentation's People

Contributors

dabroek avatar dafeso avatar edorivai avatar firstred avatar greenkeeper[bot] avatar holtkamp avatar hvalle avatar ibudasov avatar jorikmollie avatar justincase avatar lode avatar lvgunst avatar lvonk avatar makergeek avatar marinolinderhof avatar martinmollie-zz avatar mattijsbliek avatar mollierick avatar mollierobbert avatar mvdpanne avatar ndijkstra avatar robindirksen1 avatar sandervanhooft avatar saramollie avatar shirshir avatar smitsel avatar thgh avatar vernondegoede avatar willemstuursma avatar wvdeutekom avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.