docshelf keeps components optional. Use plain Markdown for most pages, then add a component when it makes the information easier to scan.

Callouts

Accordion

Show advanced details

This content starts closed and opens with the native details control.

Open details

This content starts open.

Tabs

bash
npm install docshelf

Code groups

npm
npx docshelf dev

Cards

Getting started

Install docshelf and create your first page.

Writing docs

Learn the Markdown format and component syntax.

Deploy

Publish the generated static files.

Table

Option Type Default Description
title string filename Page title and navigation label
order number 999 Sidebar order
draft boolean false Excludes the page from the build

Version badge and keyboard shortcut

This component is available since:

v0.1.0

Search opens with:

Ctrl+KOpen search

Steps

  1. Create a docs/ folder.
  2. Add Markdown files.
  3. Run docshelf build.

Image

docshelf logo
An image component using a file from public/.

Video

A video component with native browser controls.