Mangopay's documentation site is built with and deployed by Mintlify.
It is written in markdown and uses Mintlify's components with custom CSS applied on top.
To run the docs locally you need to:
-
Create a new branch of the repo (if you have access) or else fork it
-
Install Node.js and npm (use nvm as recommended here)
-
Install Mintlify
npm i -g mintlify
- Run Mintlify
mintlify dev
See Mintlify's docs for more detail.
The API reference relies on Mintlify's reusable snippets to display attributes and parameters. If making changes here, terminate the local preview beforehand and relaunch it once you're done (the local preview slows down and becomes unusable).
- For tables, use HTML not markdown (see existing tables for CSS styles)
- For hyperlinks, we generally use HTML but markdown is OK too (HTML enables opening in a new tab with
target="_blank")