Noto.docs

This repository is the public product and documentation site for Noto.

Live: https://roobli.github.io/Noto.docs/

It is a VitePress site with:

• a product home at / (pitch, screenshots, download links)
• user-facing docs under /guide/ (install, using, plugins, theming, remote control)
• the product's direction under /direction/ (positioning, principles, roadmap, open-source standard, decision log)
• an engine preview at /guide/engine-preview that dogfoods @roobli/md in the browser

No private vault content belongs here. Long-form engineering notes may still live under roobli/Noto/docs; this site is the public hub.

Dogfood path (@roobli/md)

Noto’s markdown core is MIT-licensed as @roobli/md. This site depends on it (github:roobli/md#v0.1.23, the version on Noto's main branch; the released Noto v0.0.3 ships v0.1.20) and renders guide demos with a small Vue helper (RoobliMdView): parseBlocks → read-only HTML.

That is the 自举 path toward browser-compatible notes/docs using the same engine Noto ships. It is not the full Electron app in the browser — no ProseMirror shell, vault FS, or save path here. Those stay in desktop Noto.

See Engine preview for what is live vs stubbed.

Develop locally

Requires Node 22+ and pnpm 11+.

pnpm install
pnpm docs:dev

Build the static site (output in docs/.vitepress/dist):

pnpm docs:build

Preview the production build:

pnpm docs:preview

base is set to /Noto.docs/ for GitHub project Pages.

Deploy

GitHub Actions builds on every push to main, and every six hours to pick up new releases, then hands the VitePress dist to Pages as an artifact (actions/upload-pages-artifact and actions/deploy-pages). Nothing is pushed back to the repository, so there is no gh-pages branch.

Pages settings: Source → GitHub Actions.