Technical documentation for the Frequency parachain. The current documentation can be viewed in its compiled form at https://docs.frequency.xyz. Alternatively, the latest iteration of the docs can be viewed non-formatted here.
For more information about Frequency, visit frequency.xyz or Frequency on GitHub
To build the generator locally, install mdBook and link checker. The link checker will run during build process and throw warnings for any broken internal or external links.
cargo install [email protected]
cargo install mdbook-linkcheck
npm installTo run the doc generator locally, actively build after each change and serve them via HTTP use the following command:
npm run serveOnce the local server is running, the site will automatically open in the browser at http://localhost:3000. Note, it will not automatically refresh browser page after each change.
To run the doc generator locally and preview the formatted docs from local files, use the following:
npm run buildnpm run lintThe CI will automatically deploy what's merged into main.
- mdBook — create books with Markdown