Style Guide

Reference page for the shortcodes this port ships and the markdown surfaces upstream's stylesheet already styles. Compare against hugo-book's own shortcode docs.

Hints

Info — use the Hint MDX component with type="info" in .mdx pages.

Warning — type="warning".

Danger — type="danger".

Details

Click to expand

Hidden detail body. In .mdx content this is the <Details title="…"> component.

Buttons

Internal button Upstream repo

Steps

  1. Install the theme from JSR
  2. Set book_section to your docs root (or *)
  3. Write pages — the sidebar filetree builds itself

Columns

Left column

Column layouts use the upstream .book-columns markup.

Right column

In .mdx, wrap a markdown list with <Columns>.

Typography

Element Example
Inline code book_theme
Link Caravan
Emphasis italic and bold
// Code blocks keep upstream highlighting hooks + click-to-copy
export const bookSection = "*";

A plain blockquote, distinct from the coloured hint variants above.

Keyboard

With search enabled, press / or ⌘K / Ctrl+K anywhere on the page to focus the sidebar search input — same shortcuts as upstream search.js.