CLI

Commands

init

Initialize Next.js template and all dependencies

build

Prepare notes for publication. Runs Next.js pod in the background.

options

  • --attach: attach to running engine instead of a new engine
  • --overrides: add additional config overrides
  • --sitemap: generates a sitemap

example

  • Run this command inside the root of your workspace
npx dendron publish build

with override

dendron publish build --override="siteUrl=foo.com"

dev

Builds notes and starts a local dev server. Behind the scenes, runs dendron publish build && npx next dev

export

Export notes as static HTML

options

  • --target {target}: export to specific destination
    • syntax.target:
      • github: creates a /docs directory and export notes there. If a docs folder exists, will issue prompt before deleting contents
  • --yes: automatically say yes to all prompts
  • --sitemap: generates a sitemap

Backlinks