NAME

Chandra::Markdown::App - Ready made markdown docs site application for Chandra

SYNOPSIS

use Chandra::Markdown::App;

Chandra::Markdown::App->new(
    docs_dir => '/path/to/docs',
    title    => 'My Docs',
)->run;

DESCRIPTION

Wraps Chandra::Markdown into a complete single call application: sidebar navigation, full-text search widget, active link highlighting, and a default / route that renders index.md.

ATTRIBUTES

docs_dir (required)

Path to the directory containing .md files.

title

Window title. Default: 'Documentation'.

width / height

Window dimensions. Defaults: 1100 x 750.

base_route

URL prefix for doc routes. Default: '/docs'.

nav_id

HTML id of the <nav> element. Default: 'chandra-markdown-nav'.

recursive

Scan subdirectories. Default: 1.

brand

Sidebar header text. Default: 'Documentation'.

placeholder

Search input placeholder. Default: 'Search docs...'.

METHODS

run

Start the Chandra event loop.

SEE ALSO

Chandra::Markdown, Chandra::App