Tu primer proyecto¶
El objetivo es sencillo: una página en el navegador y la misma en PDF. Necesita Guidedog. Para PDF puede usar el compilador integrado o Typst 0.15.1 o posterior. Véase Compilar e instalar Guidedog.
En macOS, instale la versión publicada con brew install insanai/guidedog/guidedog. Este comando añade el tap oficial e incluye el compilador de PDF.
Crear el proyecto¶
Ejecute esto desde un directorio donde aún no exista notes:
guidedog quickstart notes -q -p "Field Notes" -a "Your name" -v 1.0
Guidedog escribe la configuración, el primer documento RST y plantillas editables. También crea carpetas para imágenes, audio y vídeo. No sobrescribe un proyecto existente.
notes/
conf.toml
index.rst
_templates/
layout.html
book.typ
_static/
guidedog.css
guidedog.js
assets/
images/
audio/
video/
_build/
Los archivos RST contienen el texto; las plantillas, la presentación. quickstart coloca _templates/layout.html y _templates/book.typ en el proyecto, no en temas externos ni cachés. Puede revisarlos y modificarlos en cualquier momento.
Escribir la primera página¶
Sustituya notes/index.rst por lo siguiente:
Field Notes
===========
A useful explanation begins with a small example.
Measuring a square
------------------
If the side has length :math:`s`, its area is :math:`s^2`.
.. math::
A = s^2
.. note::
State the units before comparing measurements.
Compilar e inspeccionar¶
guidedog build html notes -W
guidedog build pdf notes -W
Abra notes/_build/html/index.html y el PDF de notes/_build/pdf. -W hace fallar el build ante advertencias; manténgalo en las comprobaciones. HTML contiene navegación y texto. PDF añade los elementos de página de un libro. Las matemáticas se componen para cada formato. La configuración está en Matemáticas y demostraciones.
Hacer un cambio¶
guidedog serve notes
Abra la dirección que imprime el comando. Edite y guarde la fuente, y recargue el navegador. Antes de servir HTML, Guidedog comprueba las fechas de modificación y reconstruye si han avanzado. No fuerza una recarga del navegador. Detenga el servidor con Ctrl+C.
Compile de nuevo sin editar nada. Se reutilizan los documentos sin cambios, sin releer cada página para demostrar que la salida sigue vigente. Continúe con Crear un libro pequeño.