This directory contains comprehensive documentation for the Comark library, built with the comark-docs Nuxt layer.

• Documentation Home - Start here for an overview
• Installation - Set up Comark in your project

To install the Comark Agent Skill from the published documentation site:

npx skills add https://comark.dev

See the Installation guide (section Agent Skill) for more context.

1. Parse API - String parsing

   • parseMarkdown() - Parse markdown strings
   • Types and interfaces

2. Auto-Close API - Handle incomplete syntax

   • autoCloseMarkdown() - Auto-close unclosed syntax
   • Streaming integration
   • Use cases

3. Vue Rendering - Render Comark content in Vue

   • Component props
   • Custom components
   • Slots and error handling

4. React Rendering - Render Comark content in React

   • Component props
   • Custom components
   • Props conversion

5. Svelte Rendering - Render Comark content in Svelte

   • Snippets and streaming
   • SvelteKit SSR

6. Angular Rendering - Render Comark content in Angular

   • Standalone components
   • Custom components and streaming

7. HTML Rendering - Framework-free HTML strings

8. ANSI Rendering - Terminal output

I want to...

• Install Comark → Installation Guide
• Install the Agent Skill → npx skills add https://comark.dev (see Getting Started → Agent skill above)
• Parse markdown from a string → Parse API
• Handle incomplete markdown → Auto-Close API
• Render Comark in Vue → Vue Rendering
• Render Comark in React → React Rendering
• Render Comark in Svelte → Svelte Rendering
• Render Comark in Angular → Angular Rendering
• Create custom components → Vue - Custom Components

• TypeScript → All documentation includes TypeScript examples
• Vue → Vue Rendering
• React → React Rendering
• Svelte → Svelte Rendering
• Angular → Angular Rendering

# Install dependencies
pnpm install

# Start development server
pnpm run dev

Your documentation site will be running at http://localhost:3000

docs/
├── content/              # Documentation markdown files
│   ├── index.md              # Documentation home
│   ├── 1.getting-started/    # Getting started guides
│   ├── 2.syntax/             # Syntax documentation
│   ├── 3.rendering/          # Framework and string rendering
│   ├── 5.api/                # API reference docs
│   └── 8.examples.md         # Examples
├── public/              # Static assets
└── package.json         # Dependencies and scripts

When contributing documentation:

1. Follow the existing structure - Match the format of existing docs
2. Include code examples - Show TypeScript and framework-specific examples
3. Add cross-references - Link to related documentation
4. Test all examples - Ensure code examples actually work
5. Use proper markdown - Follow Comark for components

• Headers: Use sentence case (e.g., "Parse API" not "Parse api")
• Code blocks: Always specify language (typescript, vue, etc.)
• Links: Use relative links within docs
• Examples: Include both simple and advanced examples
• TypeScript: Always include type annotations
• Comments: Explain non-obvious code

This documentation site uses:

• Nuxt 4 - The web framework
• Nuxt Content - File-based CMS
• Nuxt UI - UI components
• Tailwind CSS 4 - Utility-first CSS
• comark-docs - Documentation layer

Build for production:

pnpm run build

The built files will be in the .output directory, ready for deployment.

Deploy to:

• Vercel
• Netlify
• Cloudflare Pages
• Any Node.js hosting

• Documentation unclear? Open an issue
• Example doesn't work? Report it
• Want to contribute? Submit a PR

Documentation is under the same license as the project (ISC).