Last updated: Aug 1, 2025, 02:40 PM UTC

@knowcode/doc-builder

Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling

npm version
License: MIT

Quick Start

npx @knowcode/doc-builder@latest deploy

You are looking at a demo | NPM Package | GitHub

Features

Design & UX

  • Notion-inspired UI - Clean, modern interface
  • Dark mode support - Automatic theme switching
  • Responsive layout - Perfect on any device
  • Syntax highlighting - Beautiful code blocks

Navigation

  • Full-text search - Find anything instantly
  • Smart navigation - Hierarchical structure
  • Breadcrumbs - Always know where you are
  • Keyboard shortcuts - Navigate like a pro

Content Support

  • Mermaid diagrams - Visual documentation
  • GitHub markdown - Full GFM support
  • Interactive tooltips - Document previews
  • Version tracking - Build metadata

Deployment

  • One-command deploy - Push to Vercel
  • Static generation - Fast & secure
  • Custom domains - Your brand
  • Preview deploys - Test changes

Use Cases

Open Source

Beautiful docs for your community

Technical Teams

Internal docs developers love

API Docs

Clear, searchable references

Knowledge Base

Organize team knowledge

Simple Workflow

1️⃣ Setup

npx @knowcode/doc-builder@latest init

Create project structure and configure doc-builder

2️⃣ Deploy

npx @knowcode/doc-builder@latest deploy

Build your markdown files and deploy to production

Configuration

Configuration is fully managed through the CLI tools - no manual file editing required! The tool handles all settings automatically during setup and deployment.

Auto-Configuration

  • Auto-creation: If no doc-builder.config.js exists, one is created with all default settings
  • Auto-update: When upgrading versions, new features are automatically added to your config
  • Safe migration: Your customizations are preserved while adding new defaults
  • Backup protection: Config files are backed up before major updates

Basic Config (Reference Only)

// doc-builder.config.js
// This file is auto-generated and managed by the CLI
module.exports = {
  siteName: '@knowcode/doc-builder',
  siteDescription: 'Transform markdown into beautiful documentation',
  docsDir: 'docs',
  outputDir: 'html',
  favicon: '✨'  // Can be emoji or path to image
};

The CLI creates and updates this for you

Advanced Features (Reference Only)

// Also managed via CLI commands
features: {
  mermaid: true,      // Diagrams
  darkMode: true,     // Theme toggle
  authentication: true, // Password
  changelog: true     // Auto-generate
}

Use init or deploy commands to configure

Rich Content Examples

Mermaid Diagrams

graph LR A[Write] --> B[Build] B --> C[Deploy] C --> D[Share] style A fill:#e1f5fe style D fill:#c8e6c9

Code with Syntax Highlighting

// Beautiful code blocks
const docBuilder = require('@knowcode/doc-builder');

docBuilder.build({
  siteName: '@knowcode/doc-builder',
  features: { darkMode: true }
});

Why Choose doc-builder?

Performance

  • Lightning fast - Static generation
  • SEO optimized - Search friendly
  • Accessible - WCAG compliant

Developer Experience

  • Zero config - Works instantly
  • Version control - Git-friendly
  • Open source - MIT licensed

Cost Effective

  • Free hosting - Vercel free tier
  • No vendor lock-in - Your content
  • Export anywhere - Static HTML

Get Involved

Contributing

We welcome contributions! Check our contribution guide to get started.

Ways to help:

  • Report bugs
  • Suggest features
  • Improve docs
  • Submit PRs

Community

Join our growing community of documentation enthusiasts!

Connect with us:

License: MIT © KnowCode

Built with by developers, for developers

Get Started | You are looking at a demo | Star on GitHub