mdbook libros web
2024-09-02 Regresar Atrás
¿Qué es MDBOOK?
-
mdBook es una herramienta de código abierto diseñada para crear libros digitales en formato Markdown. Originada en la comunidad de Rust, mdBook permite a los desarrolladores y escritores técnicos generar documentación técnica, tutoriales, o manuales de forma sencilla y estructurada. La herramienta convierte archivos Markdown en sitios web navegables, con soporte para temas personalizados, búsqueda integrada, y enlaces entre capítulos. Es altamente configurable y puede manejar grandes volúmenes de contenido, lo que la hace ideal para proyectos de documentación de software y libros educativos. Además, al ser generada como un sitio web estático, la salida es rápida y ligera, ideal para alojar en GitHub Pages u otras plataformas similares.
-
Uso: mdbook es una herramienta para crear libros a partir de archivos Markdown, ideal para documentación.
- Instalación:
pkg install mdbook
- Conversión de Markdown a PDF:
- Primero, configura el libro en un directorio:
mdbook init mi_libro
- La realizar el comando de arriba se creara la estructura base de tu libro en
book.toml
van los datos como
[book] authors = ["Retired64"] language = "es" multilingual = false src = "src" title = "Retired-Git"
- Primero, configura el libro en un directorio:
- Instalación:
La carpeta book es donde se creara tu libro al final
- Coloca tus archivos Markdown en la carpeta
src/
.
SRC/
Bueno aqui va la estructura de tu libro para la creación donde en SUMMARY.md es el indice de tus páginas.
Esto debe ir por ejemplo dentro de tu archivo.
# Summary
- [Index](./pag1.md)
- [Instalacion](./pag2.md)
- [Herramientas](./pag3.md)
Y asi dependiendo cuantas páginas tengas.
EJEMPLO
├── SUMMARY.md
├── pag1.md
├── pag2.md
└── pag3.md
# 1 directorio, 4 archivos*
- Luego, compila el libro:
mdbook build
- El comando de arriba se debe ejecutar en el directorio padre del proyecto. que seria a fuera de
src/
un directorio atras desrc/
- Eso creara tu libro en formato
html
en la carpetabook/
que despúes podras subirlo como a:
- Github Pages
- Vercel
- Netlify
- Y muchas más plataformas de host gratuito (RECOMIENDO GITHUB PAGES) más facil o más bien más control de versiones.
Ver tu libro de forma Local
Servidor Python (versión 3)
- Descripción: Fácil y rápido para servir archivos estáticos.
- Comando:
pkg install python -y # Dentro de la carpeta book python3 -m http.server 8000
- Acceso:
http://localhost:8000
VER VIDEO TUTORIAL
Como desplegar Tu libro?
- Crear una cuenta en Github
- Crear un nuevo Repositorio llamado como:
Supongamos que me cree una cuenta en github con el usuario
retired-book-web
entonces el repositorio se deberia llamar
## Repositorio llamado
retired-book-web.github.io
- En ese repositorio deberas subir todos los archivos y carpetas que genero el comando
mdbook build
que creo tu libro en la carpetabook
todo lo que hay dentro de la carpetabook
debera ser subido a tu repositorio.
te invito a visitar mis redes sociales.