Getting Started

Installation

npm install markler

Project Setup

Create a content/ directory and add some markdown files:

my-site/
  content/
    index.md
    about.md
    guides/
      first-steps.md
  markler.config.json  (optional)

Building Your Site

npx markler build

This will generate HTML files in dist/.

Development Server

npx markler serve

This starts a local server with live reload — edit your markdown and see changes instantly.

Configuration

Create a markler.config.json in your project root:

{
  "content": "content",
  "output": "dist",
  "theme": "dracula",
  "siteName": "My Site"
}

Linking Between Pages

Use wiki-style links to connect your pages:

• [[page-name]] — links by slug
• [[page-name|Display Text]] — with custom text

Go back to Home or see the Mermaid examples.