Command line

markupress dev        # serve the site with live reload
markupress build      # write the static site
markupress preview    # serve the built site
markupress snapshot <version-id>

markupress alone runs dev. Each command reads the site's configuration and its markupkit.config.ts.

CommandDoes
devServes the site from its sources, and reloads open pages after any edit, addition or deletion.
buildWrites the static site to outDir (site by default), checking every link, and prints the number of pages.
previewServes the built site from outDir.
snapshot <version-id>Validates a build and records the current docs as the version <version-id> in versions/<version-id>/ (see Versions).
FlagDoes
--root <directory>The site's directory, in place of the current directory.
--base <path>The URL path the site is served under, such as /docs/, in place of the configured base.
--port <number>The port dev and preview listen on.
--draftsIncludes pages with draft: true front matter in build, as the drafts option does.
--help, -hPrints the usage.
Edit this page

Last updated