Introduction

GemBook renders Markdown content into a website and generates pages based on the directory structure. GemBook is a document site generation tool created for Gem, it is also written with Gem and built on gemkit: Markdown is rendered on the server, every page is prerendered into HTML when building, and the browser takes over the pages for client-side navigation.

Getting Started

WARNING

GemBook depends on Node.js v22+, please ensure that the node -v command can be executed

# Create docs
mkdir docs && echo '# Hello GemBook!' > docs/readme.md

# Write and preview, changes to documents reload the page
npx gem-book docs

# Specify title
npx gem-book docs -t MyApp

# Build the website into dist/web
npx gem-book build docs

More options.

Goals

• Build Markdown content into a website with one command, without project configuration
• The content is visible before JavaScript loads, and can be deployed to any static hosting
• Extend Markdown with custom elements, such as runnable examples and API documentation