centrifuge / documentation

Documentation for Centrifuge
https://docs.centrifuge.io/
GNU Affero General Public License v3.0
15 stars 71 forks source link

Centrifuge Documentation

Netlify Status

About

Centrifuge is an open, decentralized operating system that provides a method to create, exchange, and use the data used in the financial supply chain. It creates transparent and shareable relationships between interacting companies.

This project documents the procedure to set up a Centrifuge Node. For the step-by-step procedure, see Docs.

For information on the Centrifuge code, see our other repos.

To become a part of the Centrifuge community, read the Code of Conduct and join Discord.

Contributing

Please, feel free to make any contributions you think will make Centrifuge Documentation better.

Submit all pull requests to the develop branch

The develop branch is continuously deployed to a preview site. View dev site. You can submit a pull request to the repository to get a deploy preview built.

Development

Dev server

This repo uses yarn v4 to enable building on Cloudflare pages. If this is your first time using yarn v4 follow these steps:

  1. clear all generated folders (.cache, public, node_modules)
  2. install yarn v4: corepack enable and yarn init -2
  3. ensure you're using the correct node version: nvm use. You should be using node v18.19.1
  4. install dependencies: yarn install
  5. start the dev server: yarn develop

Images

Place all the static images under docs/ folder close to the relevant content and add the relative path of the image along with alt tag in the Markdown file like below

![Tinlake UI](../../images/tinlake/tinlake-ui.png)

You can use styling attributes on images

![Tinlake UI](../../images/tinlake/tinlake-ui.png#width=200px;float=right)

For more information and how to add custom attributes, refer to the gatsby-remark-image-attributes plugin.

LaTeX

We're using KaTeX to display Math formulas inside the Markdown like below:

$$
D = P \times (1 + \frac{r}{n})^{nt}
$$

License

Centrifuge Documentation is licensed under the Creative Commons Attribution-ShareAlike 2.0 License