Mojaloop Documentation
Last updated
Was this helpful?
Last updated
Was this helpful?
This is the official documentation for the Mojaloop project.
Published at:
Run npm run build to build the project to render the static vuepress site for a deployment.
For consistent rending of sequence diagrams, we build the .puml sources to .svgs using the following script.
This script requires docker to be installed and running, since it uses a docker container to run the plantuml server.
This also ensures that the sequence diagrams are easily readable inline in markdown documents.
This script also runs as a git commit hook, so any changes added to puml sources are automatically rendered to svg without you having to do anything!
If you want to skip the commit hook, you can always run git commit -n
We use vuepress-plugin-versioning to help us keep older versions of our docs for posterity. By default, when you browse the docs, you see the latest published version. Pending changes in the main/master branch are viewable under the versioning tab in the top navigation bar.
We are working to automate this process, but for now, you can make a new version of the docs with the following:
Known issue: sidebar not appearing in older versions Go to
./website/versioned_docs/<version number>/sidebar.config.jsonAnd remove the/nextat the start of each entry
You can also deploy them manually, by running:
Note that you need to have the aws cli, AWS access, and aws-mfa set up on your machine for this to work.
See for more information on the plugin.
Please refer to the for details on how to contribute to Mojaloop Docs 2.0.
Apache License. Version 2.0 See for more information.