Skip to content

Latest commit

 

History

History
134 lines (73 loc) · 3.04 KB

index.md

File metadata and controls

134 lines (73 loc) · 3.04 KB
title description
A powerful, flexible, Markdown-based authoring framework
From personal blogs to massive documentation sites, Markdoc is a content authoring system that grows with you.

{% section .hero %}

{% typewriter /%}

From personal blogs to massive documentation sites, Markdoc is a content authoring system that grows with you.

View docs {% .primary %}

{% /section %}

{% section .try .no-mobile %}

{% sandbox height="630px" options={"scrollbarStyle": null} /%}

{% /section %}

{% section .value-props %}

{% table %}


  • {% ascii "key" /%}

    {% item %}

    Open source {% .jumbo %}

    Maintain full control over your code and content. Markdoc is open-source and fully extensible. {% /item %}

  • {% ascii "pencil" /%}

    {% item %}

    Developer & writer friendly {% .jumbo %}

    Markdoc delivers a powerful, flexible, developer experience (DX) with an equally capable authoring experience (AX).

    {% /item %}

  • {% ascii "card" /%}

    {% item %}

    Adopt anywhere {% .jumbo %}

    Use Markdoc to create interactive documentation experiences, static content sites, authoring tooling, and more.

    {% /item %}

{% /table %}

{% /section %}

{% section .get-started %}

{% sideBySide %}

{% item %}

Get started quickly {% .jumbo %}

Markdoc core is a lightweight package containing everything you need to get started. If you want to get going even faster, check out our Next.js plugin and deploy a Markdoc documentation site with zero boilerplate.

Explore documentation {% .primary %}

Live edit {% .primary %} {% .live-edit %}

{% /item %}

npm install @markdoc/markdoc
import Markdoc from '@markdoc/markdoc';

const doc = `
# Hello world.
> My first Markdoc page
`;

const ast = Markdoc.parse(doc);

const content = Markdoc.transform(ast);

const html = Markdoc.renderers.html(content);

{% /sideBySide %}

{% /section %}

{% section .by-stripe %}

{% sideBySide %}

Markdoc powers Stripe documentation {% .jumbo %}

Stripe created Markdoc to power its largest and most detailed content site. Since then, we have adopted it across the company, writing hundreds of thousands of lines of Markdoc to create thousands of pages of expressive, custom documentation.

{% /sideBySide %}


{% features %}

  • Familiar syntax

    Markdoc is a syntactic extension of Markdown, so you can keep using all the syntax and tooling you are used to.

    Learn the syntax {% .primary %}

  • Easily extensible

    Markdoc lets you customize all aspects of the system, from custom tags and nodes to entirely new renderers.

    Learn more {% .primary %}

  • Built-in validation

    You can add custom validation throughout your content system, ensuring nothing breaks and your content remains consistent.

    Learn more {% .primary %}

{% /features %}

{% /section %}