Docsfy – Documentación fácil
Category : Noticias
Conoces Docsfy? Es el gestor de documentación que utilizamos para Edalitics. Con él generamos nuestra documentación de forma sencilla y ágil.
¿Qué es Docsify?
Docsify es una herramienta de código abierto (licencia MIT) diseñada para convertir archivos Markdown en un sitio de documentación web, sin necesidad de generar ficheros HTML estáticos de forma previa.
En lugar de compilar todo el sitio antes del despliegue, Docsify carga los archivos Markdown dinámicamente en el navegador, haciendo “merge” con una simple página HTML que actúa como “contenedor”.
Sus principales ventajas incluyen su ligereza, facilidad de configuración y despliegue rápido.
Para empezar a usarlo, tan solo tienes que crear un archivo “index.html” y desplegarlo en GitHub pages.
Características
- Sin archivos HTML estáticos
- Sencillo y ligero
- Plugin de búsqueda de texto completo inteligente
- Múltiples temas
- API de plugins útil
- Compatibilidad con emojis
- Compatible con IE11
- Admite renderizado del lado del servidor
¿Cómo empezar?
- Se recomienda instalar docsify-cli de forma global. Para ello, usa: npm i docsify-cli -g
- Si quieres escribir la documentación en el ./docs subdirectorio, puedes usar el init comando. Ejemplo:
- docsify init ./docs
- Una vez finalizado el proceso init, podrá ver la lista de archivos en el ./docs subdirectorio. Encontrará:
- index.html como archivo de entrada.
- README.md como página de inicio.
- .nojekyll impide que GitHub Pages ignore los archivos que empiecen con un guión bajo (_ejemplo).
- Ejecuta el servidor local con docsify serve . Permite mostrar una previsualización en tu navegador en http://localhost:3000 . Ejemplo:
- docsify serve docs
- En caso de necesitar más páginas, puede crear más archivos Markdown (ejemplo.md) en el directorio.
- Para más información, consulta el siguiente enlace: https://docsify.js.org/#