Skip to main content

How to become a Cookbook editor?

Anyone with a Github account can participate.

The cookbook is built from markdown files (.md) and served directly from githubopen in new window.

Editing on Github (for easy/quick changes)

Open the editor with the "Edit this pages on Github" link at the bottom.

When ready to propose your changes just select "Create a new branch" and give it a name:

Propose Changes

Your proposed changes will be merged after review.

Editing the Cookbook on your machine

If you prefer to preview exactly your change, then you need to run vuepress on your machine and modify the markdown files with an editor (e.g. VSCode).


For the one-time vuepress installation do:

$ cd ~/suibase/docs
$ pnpm install

To start vuepress (the server) do:

$ cd ~/suibase/docs
$ pnpm start
Open your browser at http://localhost:8080

The browser updates as you change files under ~/suibase/docs/src

See in new window for advanced markdown features.

Submit your changes as a pull request, just ask as needed (not as hard as it seems once you do it once).