Привет,
Добро пожаловать в мой третий видеоурок, на этот раз о том, как начать работу с MkDocs.
В этом видео я попытаюсь дать вам базовый обзор MkDocs и конфигурацию, состоящую из темы материала и плагина поиска.
Конфигурация
Конфигурация MkDocs, используемая в видео.
site_name: My Cool Project Documentation theme: name: material features: - search.suggest - search.highlight - content.tabs.link plugins: - search nav: - Introduction: "index.md" - Tutorial: - Tutorial Subsection: "pages/tutorial/tutorial_subsection.md" - About: "pages/about.md" - FAQ: "pages/faq.md" markdown_extensions: - attr_list
Развертывание докера
Когда вы будете готовы развернуть свой веб-сайт документации, скажем, в Docker с Nginx должны работать следующие Dockerfile и Nginx default.conf.
Файл Docker
FROM python:3.9 as builder WORKDIR /app COPY . . RUN pip install mkdocs mkdocs-material && mkdocs build FROM nginx as deploy # Copy the build to the nginx directory. COPY --from=builder /app/site/ /usr/share/nginx/html/ # Copy the nginx configuration to the nginx config directory. COPY default.conf /etc/nginx/conf.d/ EXPOSE 8080:8080/tcp
default.conf
server { listen 8080; root /usr/share/nginx/html/; index index.html; }
Я думал, что делать видео будет проще, чем печатать посты в блоге, но, к моему удивлению, сложность оказалась немного выше. Исправление ошибок занимает больше времени с видео, и, поскольку я не очень хороший ведущий, мне трудно представить контент. Надеюсь, со временем и практикой я улучшу свои навыки.
Спасибо за прочтение! 🍻
Первоначально опубликовано на http://nuculabs.dev 16 октября 2021 г.
