Sui Cookbook

Community-maintained recipes, guides, and code snippets for Sui developers. Published at https://chainmovers.github.io/sui-cookbook/.

This content was originally part of suibase.io and was split into its own repository so it can grow independently. The full authorship history was preserved during the split.

Local development

pnpm install
pnpm docs:dev      # live preview at http://localhost:8080
pnpm docs:build    # production build into src/.vuepress/dist

Requires Node 22+ and pnpm.

Layout

src/
  README.md          Introduction (cookbook home)
  guides/            Longer-form guides
  code/              Code snippets by topic
  .vuepress/         VuePress config, theme, navbar, sidebar, assets

Contributing

Edit or add Markdown under src/guides/ or src/code/. Each page shows its contributors automatically, generated from git history — so please commit with the identity you want credited.

Deployment

Every push to main triggers .github/workflows/deploy-docs.yml, which builds the site and publishes it to the gh-pages branch. GitHub Pages serves that branch at the URL above.

License

Apache-2.0. See LICENSE.