Cum să documentezi un proiect cu MkDocs 📹

  • 1 minute de citit
  • 3 exemple de cod

Disponibil și în English

Pe această pagină

Salut,

Bine ai venit la al treilea meu tutorial video, de data aceasta despre cum să începi să folosești MkDocs.

În acest video încerc să îți ofer o prezentare de bază a MkDocs și o configurație formată din tema material și pluginul de căutare.

https://www.youtube.com/watch?v=X-LbOBAd-xg

Configurare

Configurația MkDocs folosită în video.

site_name: My Cool Project Documentationtheme:  name: material  features:    - search.suggest    - search.highlight    - content.tabs.linkplugins:  - searchnav:  - Introduction: "index.md"  - Tutorial:      - Tutorial Subsection: "pages/tutorial/tutorial_subsection.md"  - About: "pages/about.md"  - FAQ: "pages/faq.md"markdown_extensions:  - attr_list

Implementare cu Docker

Când ești gata să îți implementezi site-ul de documentație, de exemplu în Docker cu Nginx, următorul Dockerfile și fișierul default.conf pentru Nginx ar trebui să fie suficiente.

Dockerfile

FROM python:3.9 as builderWORKDIR /appCOPY . .RUN pip install mkdocs mkdocs-material && mkdocs buildFROM 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;}

Credeam că realizarea de videoclipuri va fi mai ușoară decât scrierea articolelor de blog, dar spre surprinderea mea dificultatea este puțin mai mare. Corectarea greșelilor durează mai mult la videoclipuri, iar fiindcă nu sunt un prezentator prea bun, mă chinuiesc să prezint conținutul. Sper ca, cu timpul și cu exercițiu, să îmi îmbunătățesc abilitățile.

Mulțumesc că ai citit! 🍻