ehundu/andamio-documentacion
Andamio de documentación
Una documentación con menú por secciones, índice de cada página, anterior y siguiente y un enlace para editarla en tu repositorio.
Menú por seccionesÍndice de la páginaModo oscuro
Ver la demo (se abre en una pestaña nueva) Ver el código (se abre en una pestaña nueva)
Créalo con Composer
composer create-project ehundu/andamio-documentacion mi-sitio
También puedes crearlo desde GitHub con «Use this template»; los dos caminos están en la guía para empezar con un andamio.
- secciones
- 3
- páginas de ejemplo
- 9
La estructura de partida para documentar un proyecto, con el mismo esquema que esta documentación. Las páginas son Markdown, se agrupan en secciones que se declaran en un fichero y no hay base de datos ni panel: se editan, se revisan y se versionan como el código.
En pantallas estrechas, el menú y el índice se pliegan en dos desplegables, sin JavaScript. No trae buscador, ni versiones: las preguntas frecuentes de la propia documentación cuentan cómo resolver cada cosa.
Lo que trae
- El menú de la izquierda, con las secciones de
datos/secciones.ymly sus páginas. - El índice de la página a la derecha, que sale de sus encabezados.
- Anterior y siguiente al final de cada página, en el orden del menú.
- Un enlace «Editar esta página» que abre su fichero en tu repositorio.
