GET STARTED
Instalación
Para instalar MkDocs, ejecute el siguiente comando desde la línea de comandos:
pip install mkdocs
pip install mkdocs
Creando un nuevo proyecto
Comenzar es muy fácil. Para crear un nuevo proyecto, ejecute el siguiente comando desde la línea de comandos:
mkdocs new my-project
cd my-project
Hay un solo archivo de configuración llamado mkdocs.ymly una carpeta nombrada docsque contendrá los archivos de origen de la documentación ( docses el valor predeterminado para la configuración de docs_dir ). En este momento, la docs carpeta solo contiene una única página de documentación, llamada index.md.
MkDocs viene con un dev-server incorporado que le permite obtener una vista previa de su documentación mientras trabaja en ella. Asegúrese de estar en el mismo directorio que el mkdocs.yml archivo de configuración y luego inicie el servidor ejecutando el mkdocs serve comando:
mkdocs serve
On Lan:
mkdocs serve -a 0.0.0.0:8000
Abra http://127.0.0.1:8000/en su navegador y verá que se muestra la página de inicio predeterminada:
Build
Eso luce bien. Está listo para implementar el primer paso de su MkLorum documentación. Primero construye la documentación:
mkdocs build
Esto creará un nuevo directorio, llamado site. Eche un vistazo dentro del directorio:
$ ls site
about fonts index.html license search.html
css img js mkdocs sitemap.xml
Elegir otra carpeta
mkdocs build -d docs-obsi-pub