README.md

MkDocs en Docker

Características

Imagen creada con:

• Python 3.9

• MkDocs 1.6.0

• MkDocks-Material 9.5.27

Iniciar el Servicio

Con docker run

docker run --rm -it -p 8000:8000 -v .:/usr/src/app ecespedes/mkdocs:1.0.0 bash

Con docker-compose

name: mkdocs
services:
  mkdoc:
    image: ecespedes/mkdocs:1.0.0
    container_name: mkdocs
    stdin_open: true
    tty: true
    ports:
      - 8000:8000
    volumes:
      - .:/usr/src/app
    restart: always

Ingresar al contenedor

docker exec -it mkdoc bash

Comandados

Crear nuevo proyecto

mkdock new [nombre_proyecto]

Iniciar el servidor para desarrollo

mkdocs serve -a 0.0.0.0:8000

Exportar a formato para web-server

mkdocs build

Temas y Plugins

Para incluir mas temas y/o plugins editar el archivo requirements.txt

puede obtener nuevos temas en:

Temas

Plugins

---

Sitios oficiales

MkDocs

MkDocs-Material

Cómo utilizar Markdown para escribir documentación | Adobe Experience Cloud