markpage

Markpage

Markpage helps you render Markdown files as HTML pages with any framework.

Point Markpage at a directory with markdown files and get organized navigation structure and content that you can use to render in your app.

What it does

Point Markpage at a directory with markdown files and .index.json files, and get:

• Organized navigation structure for your content
• Multiple output formats (app bundles, website navigation)
• Framework-agnostic utilities that work with React, Vue, Svelte, Angular, or vanilla JavaScript
• Optional component system for embedding interactive components in markdown (via separate framework packages; Svelte support available)

Quick Start

npm install markpage

import { buildPages } from 'markpage/builder';

await buildPages('./my-content', {
  appOutput: './src/lib/content',
  includeContent: true
});

Component System (via @markpage/svelte)

Component embedding is provided by the separate @markpage/svelte package. It lets you embed interactive Svelte components directly in markdown files:

# My Documentation

Here's a regular paragraph.

<TestButton variant="primary" text="Click me" />
<TestButton /> <!-- Uses default props -->

Components are registered and rendered with the Markdown component:

<script>
  import { Markdown, MarkpageOptions } from '@markpage/svelte';
  import TestButton from './TestButton.svelte';

  const options = new MarkpageOptions()
    .addCustomComponent('TestButton', TestButton);
</script>

<Markdown 
  source={markdownContent}
  {options}
/>

Framework Integrations

• Svelte: @markpage/svelte is available on npm.

npm install @markpage/svelte

• React: not available yet — feel free to contribute an official @markpage/react integration (PRs welcome).

Getting Started

For detailed step-by-step instructions, see the Getting Started Guide.

Advanced Features

• Custom Components - Create and use custom Svelte components in markdown
• Token Overrides - Override built-in markdown tokens and create extensions

CLI Usage

Build for App/Website

npx markpage build ./my-docs --output ./src/lib/content

Use Cases

Content Sites

Perfect for documentation, blogs, knowledge bases, and any markdown-based content.

Websites

Create websites with organized content and easy navigation management.

Examples

• Test suite - Comprehensive examples in the tests directory

Contributing

👨‍💻 Want to contribute? See our How to Contribute guide.

License

MIT License