La wiki de TempWin

Herramientas de usuario

Herramientas del sitio

Traza: • mkdocs • koodo_reader • heidisql • anytype • libreoffice • torrserver • fbreader • yacreader • rustdesk • sizer
informatica:software:mkdocs

Diferencias

Muestra las diferencias entre dos versiones de la página.

Enlace a la vista de comparación

Ambos lados, revisión anteriorRevisión previa
Próxima revisión		Revisión previa
informatica:software:mkdocs [2021/11/30 15:39] – [Uso] tempwininformatica:software:mkdocs [2023/03/07 09:00] (actual) – [Material for MkDocs] tempwin
Línea 3: Línea 3:
 Generador de sitios web estáticos escrito en Python y centrado en la construcción de documentación. Generador de sitios web estáticos escrito en Python y centrado en la construcción de documentación.
  
-La documentación se escribe con la sintaxis Markdown.+La documentación se escribe con la sintaxis [[informatica:markdown|Markdown]].
  
   * [[https://www.mkdocs.org/|Web oficial]]   * [[https://www.mkdocs.org/|Web oficial]]
Línea 42: Línea 42:
  
 Eso construirá la documentación y la tendremos accesible desde http://localhost:8000 Eso construirá la documentación y la tendremos accesible desde http://localhost:8000
 +
 +==== Escribir documentación ====
 +
 +Lo mínimo es que exista un fichero ''index.md'' dentro del directorio ''docs''. Luego podemos organizar la documentación como queramos:
 +
 +<code>
 +miproyecto/
 +├── docs
 +│   └── index.md
 +│   └── pagina2.md
 +│   └── pagina3.md
 +</code>
 +
 +Incluso anidando ficheros Markdown en varios directorios:
 +
 +<code>
 +docs/
 +    index.md
 +    user-guide/getting-started.md
 +    user-guide/configuration-options.md
 +    license.md
 +</code>
 +==== Generar sitio estático ====
 +
 +<code>
 +mkdocs build
 +</code>
 +
 +Esto creará un directorio llamado ''site'' donde se habrá generadon los ficheros necesarios para poder subirlos a cualquier servidor web y servir la documentación.
 +
 +===== Temas =====
 +
 +Una vez instalados, se usan indicándolo en el fichero de configuración ''mkdocs.yml'':
 +
 +<code yaml>
 +theme:
 +    name: material
 +</code>
 +
 +  * [[https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes|Listado de temas para MkDocs]]
 +
 +==== Material for MkDocs ====
 +
 +  * https://squidfunk.github.io/mkdocs-material/
 +
 +Para instalar este tema (también instala todas las dependencias como el propio MkDocs):
 +
 +<code>
 +pip install mkdocs-material
 +</code>
 +
 +Para incluir admonitions (mensajes importantes):
 +
 +<code yaml>
 +markdown_extensions:
 +  - admonition
 +  - pymdownx.details
 +  - pymdownx.superfences
 +</code>
 +
 +Para traducir al español:
 +
 +<code yaml>
 +theme:
 +    name: material
 +    language: es
 +</code>
informatica/software/mkdocs.1638283145.txt.gz · Última modificación: por tempwin