Markdoc: Framework para la creación de documentación basado en Markdown desarrollado por Stripe
Markdoc: Framework para la creación de documentación basado en Markdown desarrollado por Stripe

Markdoc es una sintaxis y una cadena de herramientas basadas en Markdown para crear experiencias y sitios de documentación personalizados.

Con Markdoc puedes diseñar y potenciar documentación, como por ejemplo toda la documentación pública de Stripe, el sitio de contenido más grande y complejo creado con este sistema.

SABER MÁS SOBRE MARKDOC

Puedes crear desde blogs personales hasta sitios de documentación masivos, Markdoc es un sistema de creación de contenido que crece contigo.

Características principales de Markdoc

Fuente abierta

Obtén el control total sobre el código y el contenido. Markdoc es de código abierto y completamente extensible.

Desarrollo y escritura amigable

Markdoc ofrece una experiencia de desarrollador (DX) poderosa y flexible con una experiencia de creación (AX) igualmente capaz.

Sintaxis familiar

Markdoc es una extensión sintáctica de Markdown, por lo que puede seguir usando toda la sintaxis y las herramientas a las que está acostumbrado.

Fácilmente extensible

Permite personalizar todos los aspectos del sistema, desde etiquetas y nodos personalizados hasta renderizadores completamente nuevos .

Validación incorporada

Puedes agregar una validación personalizada en todo el sistema de contenido, asegurándote de que nada se rompe y de que el contenido permanece consistente.

Instalación

Para comenzar con Markdoc, primero instala la biblioteca:

npm install @markdoc/markdoc

or

yarn add @markdoc/markdoc

Impórtalo a tu aplicación:

const Markdoc = require('@markdoc/markdoc');

Si usas ESM:

import Markdoc from '@markdoc/markdoc';

Luego use Markdoc en tu aplicación o herramienta:

const doc = `
# Markdoc README

{% image src="/logo.svg" /%}
`;

const ast = Markdoc.parse(doc);
const content = Markdoc.transform(ast);
return Markdoc.renderers.react(content, React);

Desarrollo

  1. Arranca npm install
  2. Arranca npm run build
  3. Arranca un test usando npm test