shiso
GitHub
Getting started

Introduction

A static docs site generator configured with a single docs.json file.

Shiso turns a folder of Markdown and MDX files into a fast, fully static documentation site. Everything about the site — navigation, branding, SEO, redirects — lives in one docs.json file, so the whole site can be configured in one place.

How it works#

  • Write pages as .mdx (or .md) files under content/docs
  • Describe your site once in docs.json
  • Build to plain HTML with pnpm build — every page is prerendered, then hydrated into a client-side app for instant navigation

What you get#

  • Validated configuration: supported docs.json keys are strictly validated, with clear errors for malformed or unknown options
  • Site chrome: navbar links and buttons, footer socials and link columns, and a dismissible announcement banner
  • Theming: light/dark modes, accent colors, custom fonts, and backgrounds
  • SEO built in: canonical URLs, Open Graph tags, structured data, sitemap.xml, redirects, and last-modified timestamps from git history
  • Docs components: callouts, tabs, steps, cards, code groups, and more, available in every page without imports

Get started#

  1. Installation — create a standalone Shiso project
  2. Configuration — docs.json options
  3. Writing content — Markdown, MDX, and components
Last updated on
Installation