Guía Markdown de Docsify

Docsify es una herramienta con la que podrás redactar la documentación de tus proyectos, generando una web a partir de dicha documentación. Podrás redactar texto con Markdown y luego subir la web resultante a Vercel, Netlify o GitHub Pages.

Acerca de Docsify

Docsify generará la documentación de tus proyectos al vuelo, al contrairo de lo que hacen aplicaciones como GitHub Pages o Docusaurus. Los archivos Markdown se parsearán cuando sean requeridos, mostrándose como una web. No se generarán archivos HTML estáticos, siendo a su vez una aplicación ligera.

Docsify soporta una gran cantidad de plugins, algunos de los cuales se incluyen en el código base, como la API de búsqueda. Podrás personalizar el aspecto de la interfaz y configurar los menús fácilmente. También incorpora por defecto tablas de contenido, por lo que no necesitarás crearlas manualmente.

Docsify cincluye varios temas por defecto, aunque también podrás crear tu propio tema.

Instalación de Docsify

Para usar Docsify necesitas tener tanto el gestor de paquetes npm como Node.js instalado en tu sistema. Si no lo tienes, consulta el tutorial de instalación de Node.js.

Lo más recomendable según la documentación oficial es que instales el paquete docsify-cli globalmente para así poder inicializar proyectos con facilidad. Para instalar esta herramienta, abre una ventana de terminal y usa este comando:

npm i docsify-cli -g

Si nunca has usado la línea de comandos y tienes tiempo, puedes aprender a usarla consultando el tutorial de introducción a la línea de comandos.

Una vez instalado el paquete docsify-cli, para crear un proyecto basta con que uses el comando docsify init seguido del directorio donde quieres crear el proyecto. Por ejemplo.

docsify init ./docs

Una vez creado, accede al directorio reción creado y usa el siguiente comando para inicializar el servidor de desarrollo y mostar el proyecto en tu navegador:

docsify serve docs

Ahora podrás editar los archivos Markdown del proyecto o crear nuevos archivos para crear tu documentación. Los directorios que crees, se corresponderán con la estructura organizativa y URLs de tu documentación.

Para más información, puedes consultar la documentación de Docsify.

Soporte Markdown de Docsify

Docsify soporta los siguientes elementos de la sintaxis básica y avanzada de Markdown:

Soporte adicional de Docsify

Docsify también soporta los siguientes elementos de la sintaxis avanzada de Markdown:

==texto resaltado==

<mark>texto resaltado</mark>

Alternativas a Docsify

Si prefieres usar un generador de sitios estático, tienes también disponibles otras herramientas con las que podrás generar tu documentación.

Por ejemplo, podrías usar Docusaurus, que es una aplicación con la que podrás crear sitios estáticos con React y Markdown para luego generar una web estática que podrás subir a Vercel o Netlify. Si nunca has usado React, puedes aprender a usarlo desde cero con este tutorial de introducción a React.

Otra buena alternativa podría ser GitHub Pages, que tal y como puedes deducir, se integra como un guante con GitHub.

Si prefieres un concepto diferente, también puedes probar MkDocs, que es otra herramienta creada con Python que te permite generar sitios web estáticos.

Más información acerca de Docsify

Consulta los siguientes enlaces para obtener más información acerca de Docsify:

• Web: Accede a la web de Docsify
• Repositorio: Accede al repositorio de Docsify
• Documentación: Consulta la documentación de Docsify