Getting started
Start with a small site, write a page, then build it for your host. Markupress provides navigation, search, versioning and a Looma theme.
Use Node 22.22.2 or later in Node 22, or 24.15 or later in Node 24.
Create a site
Run the starter in a new folder:
npm create markupress@latest docs
cd docs
npm install
npm run devOpen the local address printed in your terminal. The starter includes a home page, guide pages, a component and configuration. Its scripts and pinned dependencies are ready to use.
Change a heading in docs/index.md and save. The dev server reloads your page after edits, additions and deletions.
Write your first page
A Markdown file is enough. Put this in docs/index.md:
Add more pages in docs/. Folders become sections, and the site's navigation follows your project structure.
Build and preview
The starter provides scripts for both steps:
npm run build
npm run previewbuild writes a static site to site/. Preview it locally, then upload that directory to any static host. See Deploy for hosting examples.
Add to an existing project
Already have a project? Choose your package manager:
npm install markupresspnpm add markupress @nextwebwg/html-next @threadlabs/loomaWhy does pnpm list three packages?
HTML Next and Looma are peer dependencies, so your site and its components share one copy of each. npm installs them with Markupress. A pnpm site declares them directly so pages can link components by package name.
Use the CLI directly when your project has no starter scripts:
npx markupress dev # serve docs/ with live reload
npx markupress build # write the static site to site/
npx markupress preview # serve the built siteWhere to go next
- Write richer pages with callouts, tabs and code groups.
- Make it yours with shared colors, fonts and layout widths.
- Configure the site when you need more than the defaults.