▍Mkdocs¶

С настройкой автоматической сборки проекта сайта на MkDocs можно ознакомиться здесь.

Редакторы с поддержкой markdown¶

VS Code
Atom

Полезные плагины¶

Настройка иконок:

markdown_extensions:
    - pymdownx.emoji:
        emoji_index: !!python/name:materialx.emoji.twemoji
        emoji_generator: !!python/name:materialx.emoji.to_svg

Пример:

, , , , , , , , , ,

Коды:

:fontawesome-solid-computer: , :octicons-moon-24: , :octicons-alert-24: , :fontawesome-brands-android: , :fontawesome-regular-address-card: , :abacus: , :coffee: , :material-code-json: , :material-docker: , :octicons-tag-16: , :alien:

Поиск кодов иконок

Dockerfile¶

Пример сборки своего образа для Mkdocs со всеми плагинами:

FROM squidfunk/mkdocs-material

RUN apk add rsync build-base ttf-ubuntu-font-family libffi-dev zlib-dev \
    libwebp-dev jpeg-dev harfbuzz-dev fribidi-dev freetype-dev \
    cairo-dev musl-dev pango-dev gdk-pixbuf-dev && \
    /usr/local/bin/python -m pip install --upgrade pip && \
    pip install mkdocs-with-pdf && \
    pip install mkdocs-bootswatch && \
    pip install mkdocs-blog-plugin && \
    pip install mkdocs-awesome-pages-plugin && \
    pip install mkdocs-roamlinks-plugin

Собираем:

docker build -t srv/mkdocs .

Ставим метку:

docker tag srv/mkdocs registry.example.com/mkdocs

Отправляем образ с меткой в реест:

docker push registry.example.com/mkdocs

C настройкой частного реестра можно ознакомиться по ссылке