Publish CLI
Summary
Commands for publishing your notes
Usage
dendron publish <cmd>
commands for publishing notes
Positionals:
cmd a command to run
[string] [required] [choices: "init", "build", "dev", "export"]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--wsRoot location of workspace
--vault name of vault
--quiet don't print output to stdout
--dest override where nextjs-template is located [string]
--attach use existing dendron engine instead of spawning a new one
[boolean]
--noBuild skip building notes [boolean] [default: false]
--overrides override existing siteConfig properties [string]
--target export to specific destination [string]
--sitemap generates a sitemap
--yes automatically say yes to all prompts
See Publish for more information about publishing your notes.
Commands
init
Initialize Next.js template and all dependencies
build
Prepare notes for publication. Runs Next.js pod in the background.
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
Examples
- build and preview the site locally
dendron publish dev
-
build your site to prepare for publication
From CommonGo to text →Run the following command to prepare your notes for publishing.
npx dendron publish build -
override a default option while building
dendron publish build --overrides="siteUrl=foo.com"
Backlinks