Blockchain Documentation

Installation

Node V18+ is required.

If you are using nvm use nvm use 18.

npm i

Preview

After running the command below the documentation usually opens in the browser under http://localhost:5173/.

Always use experimental for general document writing. The files update instantly in the browser.

Tips

• It is highly recommended to turn on disable cache in your Browser while working on documentation.

• If you create any new pages you will need to stop vitepress, and restart the preview.
• You can actively preview changes to a single document in the browser while a dev command is running, meaning the page auto-refreshes.

All Files

This has live updates, and renders all files.

npm run dev

Experimental

This does not update live

npm run dev:experimental

Staging

This does not update live

npm run dev:staging

Mainnet

This does not update live

npm run dev:mainnet

Build

Builds a static version of the website that can be deployed anywhere.

npm run build:all

Extended Functionality

File Environment Extension Guide

Deployments are based on the name.

Any file without the extension .experimental.md or .mainnet.md or .staging.md will only be deployed to their respective environments.

If the file does not contain any of the above extensions, it will be deployed to all environments.

A Note About Links

When you are linking an environment extension file, DO NOT APPEND staging, mainnet, or experimental.

This means if you have a file named test.experimental.md, you should link it as the following:

[My Test File](./test.md);

Environment Sections

If you need one file in docs to have specific content for a specific environment you can use these tags as long as the changes do not include an environment extension link.

They support inline as well.

You cannot use links inside of these sections, they are meant for small text edits.

<Experimental>
Only shows in experimental
</Experimental>

<Staging>
Only shows in staging
</Staging>

<Mainnet>
Only shows in mainnet
</Mainnet>

File Order Guide

order is an optional property in the front matter at the top.

Specifying the order as a lesser number ensures it is higher up in the sidebar.

ie.

• -99999999 - Highest
• 1 - High
• 2 - Medium
• 3 - Low
• 99 - Lowest

---
title: 'Example Markdown File'
order: -999
---

# Example Markdown File

Placeholder