Plantilla de documentación
Para poder publicar nuestra documentación (organización de sutty, metodología de trabajo, entorno de trabajo, herramientas, jekyll, liquid, plugins, bootstrap, etc, etc) estaríamos necesitando una plantilla correspondiente, creo que las features deberían ser (agreguen):
-
Índice / Tabla de contenido -
Cada artículo disponible sale en el índice para poder navegar todos los temas juntos -
Los artículos dentro de la misma categoría se organizan en capítulos
-
-
Buscador -
Temas claro y oscuro -
Articulo individual con: -
Cada artículo tiene su tabla de contenido propia -
Legibilidad: Tipografía sans-serif, ancho de columna de no más de 70 caracteres -
Resaltado de sintaxis -
Estaría bueno poder elegir el resaltador de sintaxis para que se asemeje al que estás usando
-
-
-
Dogfooding -
Escribirlo nosotres -
Que los ejemplos de código salgan del código mismo -
Usar el editor de Sutty
-
-
???
Referencias, no sé qué tanto espacio haya para innovar, la idea es que el foco esté puesto en el contenido y navegarlo:
https://long-pig.cloudvent.net/ (es simple, podríamos implementar algo similar muy rápido)
https://rubydoc.info/gems/yard/file/docs/GettingStarted.md (tiene tabla de contenido del artículo)
Edited by fauno