Guidedog / Documentación 0.2.0

Manual de Guidedog

Escriba una vez. Explique bien. Publique en la web y en papel.

Guidedog genera sitios HTML y libros PDF a partir de fuentes reStructuredText y Markdown. No requiere un entorno de Python ni una instalación externa de LaTeX. El motor de conversión se llama Guidedoc. Typst compone las páginas PDF y Guidedog genera el sitio directamente.

Un proyecto pequeño necesita tres cosas: un documento fuente, una tabla de contenidos y conf.toml. Empiece por Tu primer proyecto. Para una tarea concreta, consulte Tareas prácticas; para un contrato exacto, Referencia.

Fig. 1 Un proyecto fuente, dos publicaciones.

Aprender

• Tutoriales

  • Tu primer proyecto

  • Crear un libro pequeño

• Guías temáticas

  • Redactar documentos

  • Dominios

  • Cómo funciona un proyecto

  • Matemáticas y demostraciones

  • Diagramas que explican

  • Tipografía para la lectura

  • Plantillas

  • Imágenes, vídeo, audio y descargas

  • Internacionalización

  • Enlazar con otros proyectos

  • Declarar tipos de objetos

  • Documentar Python con autodoc

  • Documentar Odin

Trabajar

• Tareas prácticas

  • Compilar e instalar Guidedog

  • Compilar y publicar documentación

  • Migrar un proyecto de Sphinx

  • Documentar una base de código

  • Mantener esta documentación

• Referencia

  • Referencia de la línea de comandos

  • Referencia de configuración

  • Lectores, renderizadores y generadores

  • Mensajes de error

  • Compatibilidad con Sphinx

Comprender

• Funcionamiento interno

  • El motor Guidedoc

  • Invariantes antes que algoritmos

  • Publicar una generación completa

  • Memoria y propiedad

• Acerca de este manual

  • Resultados de verificación

• Guidedog

  • Crear un proyecto

  • Instalar

  • Compilar desde las fuentes

  • Traducir con Guidedog

  • Leer e integrar

  • Créditos y licencia

Referencia de la API

• API Reference