Generar documentación con archivos Markdown usando Docsify

Si está creando un complemento gratuito, un marco de trabajo o un script de código abierto necesitarás documentación. Es crucial para documenta tu trabajo, Tanto para su cordura como para ayudar a otros que quieran aprender su increíble recurso..

Sin embargo, crear documentación en línea puede ser un verdadero dolor. Agradecidamente, Docsificar lo hace más fácil proporcionando una generador de documentación libre que se ejecuta en Markdown.

Esto es no es un generador de sitio estático típico y lo hace No requiere páginas estáticas HTML / CSS.. En cambio, carga los archivos de Markdown dinamicamente y los muestra como páginas web. Con buena pinta!

Echa un vistazo a la página principal de Docsify para una vista previa del diseño, junto con más detalles de configuración.

Requiere que usted crea el archivo index.html tu mismo, que luego puede cargarse en GitHub Pages o hospedarse en su propio servidor. A partir de ahí, solo escribir archivos de Markdown para cada página y usa esos como tus documentos primarios.

Todo el proceso se describe en detalle en el guía de inicio rápido, así que ese es probablemente el mejor lugar para comenzar. Esto puede todos corren a través de npm, por lo que realmente ayuda conocer su indicador de comando o al menos estar dispuesto a aprender.

Es posible crear un archivo HTML sin procesar y copiar y pegar la plantilla de la guía de configuración de Docsify. Pero te recomiendo haciéndolo dinámicamente, ya que ahorra un montón de tiempo, y ese no es realmente el punto?

A medida que aprendes el sistema Docsify, puedes Agrega funciones usando Markdown o HTML en bruto.. Estas características incluyen una barra de navegación personalizada e incluso tu propia portada con el logo de tu proyecto.

Docsificar incluso viene empaquetado con un montón de temas gratis Si quieres diseños pre-diseñados para trabajar. O tu puedes navegar a través de su galería escaparate Para ver qué proyectos utilizan Docsify para su documentación..

Todos Información de configuración básica y descargas de archivos se puede encontrar en GitHub, así que dirígete allí si quieres darle una oportunidad a esto.

Tú también puedes Vea una demostración en vivo en la página principal de documentación de Docsify. que, por supuesto, se ejecuta en Docsify. Entonces, si te gusta ese diseño de página web puedes usar esa misma plantilla y ejecutarla a través de Docsify, 100% gratis y de código abierto..