Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 916 Bytes

README.md

File metadata and controls

18 lines (15 loc) · 916 Bytes

FinBox Documentation

Holds the documentation for FinBox SDK: https://docs.finbox.in

Setting up locally

Make sure node (with npm) are installed on your system. Just navigate to the repository directory then and run the following command:

npm install

To run it locally:

npm run docs:dev

Adding or modifying articles

  • This documentation is written using VuePress with the default theme. All articles are written in markdown format. Please refer to the official documentation of VuePress to see more about advanced features or configurations.
  • Create a branch from master, make the changes or add an article and then raise a pull request asking for a review to merge it to the master branch.
  • As soon as the changes are reviewed and the branch is merged to master, the GitHub pages will update automatically.