Guide

  • Getting started

    Create a documentation site and publish your first page.

  • Project structure

    The files a site keeps in known places, and how MarkupKit options compose.

  • Writing

    Pages, front matter, Markdown, code blocks and components.

  • Navigation

    Sections, sidebars, folders, the outline, the footer and the not-found page.

  • Versions

    Snapshots, the versions option and the switcher.

  • Theme

    Tokens, the home page and site layouts.

  • Content Security Policy

    The generated Content Security Policy and a site's own scripts.

  • Search

    Local or contextual hosted search, keyboard selection and content exclusions.

  • SEO

    Page titles and descriptions, Open Graph, canonical links, sitemap.xml and robots.txt.

  • Deploy

    Publish the static site on GitHub Pages, Vercel, Netlify or any static host, under any base path.

  • Languages
  • Migrating from Docusaurus and VitePress

    Convert a Docusaurus or VitePress site's files, front matter, sidebars and Markdown into Markupress's model, once.

Edit this page

Last updated