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
- Arranca
npm install
- Arranca
npm run build
- Arranca un test usando
npm test
Relacionado
Zettlr: Un editor de Markdown hecho a medida para los estudiantes del Siglo XXI En Ciberninjas nos encanta implementar y fomentar el uso de Markdown. Por ello, con anterioridad ya hemos visto qué es Markdown y algunos de los mejores editores Markdown además de haber repasado las características de los mejores editores de texto entre los que también puedes encontrar grandes aplicaciones con las que trabajar usando el lenguaje de marcado ligero: Markdown. Hoy, vamos a hechar un vistado a ¡SEGUIR LEYENDO!
Mejores Proyectos de Github para Desarrolladores Web por Iain Freestone (Julio) En estos recopilatorios, voy a publicar los mejores proyectos de Github enfocados al desarrollo web y que son tendencia en los últimos días. Los agradecimientos de estos recopilatorios, puedes dejárselos a Ian Freestone que es el encargado de hacer tanto y tan buen trabajo, ¡Gracias por tanto Ian! ??? Además puedes suscribirte a su lista de correos semanal, seguirle a través de su página web (https://iainfreestone.com/) ¡SEGUIR LEYENDO!
Mejores Editores de Markdown Los mejores editores de Markdown creados por y para ser usados con el lenguaje de marcado ligero Markdown que pelea por convertirse en un estándar, la mayoría de estos editores pueden instalarse tanto en Windows como en Linux. Si aún no sabes que es Markdown, estás tardando en descubrirlo. A continuación, vamos a ver la mejor colección de editores de Markdown del mundo y también, una ¡SEGUIR LEYENDO!
Incluye diagramas en Github dentro de tus archivos Markdown con Mermaid Una imagen vale más que mil palabras, y ahora puedes crear y editar rápidamente diagramas en Markdown usando el soporte de Mermaid dentro de tus archivos de Markdown. [azonpress template="box" asin="B098KHTVJ2"] Mermaid es una herramienta de gráficos y diagramas basada en JavaScript que toma definiciones de texto inspiradas en Markdown y crear diagramas dinámicamente en el navegador. Mantenido por Knut Sveidqvist, Mermaid admite un montón de ¡SEGUIR LEYENDO!
