24/10/2025 –, Principiante
Aprenda a criar sites de documentação usando Python e Markdown com MKDocs. Gere páginas HTML estáticas com visual profissional de forma simples e rápida.
Para acompanhar bem a palestra "MKDocs Desvendado – Documentação Sem Complicações", é desejável que o público tenha familiaridade básica com alguns conceitos, mas nenhum conhecimento avançado é obrigatório. A proposta é justamente tornar o tema acessível para o maior número possível de pessoas.
Os conhecimentos que podem ajudar na melhor compreensão da atividade são:
Noções básicas de Markdown, já que o MKDocs utiliza esse formato para estruturar o conteúdo da documentação.
Conhecimentos introdutórios de Git e GitHub são bem-vindos, especialmente na parte em que abordamos publicação da documentação online.
Familiaridade com linha de comando (terminal), mesmo que em nível iniciante, ajudará na execução de comandos simples durante as demonstrações.
Ainda assim, a palestra será conduzida de forma didática e acolhedora, com explicações passo a passo. Mesmo quem nunca usou o MKDocs sairá com uma boa base para começar a criar suas próprias documentações.
¿Qué pueden esperar aprender los participantes en tu actividad?:As pessoas que participarem da palestra "MKDocs Desvendado – Documentação Sem Complicações" poderão esperar uma imersão prática e reflexiva sobre como criar documentações técnicas eficazes, com foco na simplicidade, acessibilidade e organização do conhecimento.
Ao final da atividade, o público terá aprendido:
O que é o MKDocs e por que ele é uma excelente escolha para criar sites de documentação técnica de forma rápida e intuitiva.
Como estruturar uma documentação técnica desde o início, utilizando arquivos Markdown.
Como instalar e configurar o MKDocs, incluindo estrutura básica de um projeto.
Como utilizar o tema "Material for MkDocs" para obter uma aparência moderna e profissional sem necessidade de front-end.
Como organizar seções, menus e navegação em uma documentação clara e acessível.
Boas práticas de escrita técnica e como a documentação pode impulsionar a colaboração, especialmente em projetos open source.
Além disso, a atividade incentiva uma mudança de mentalidade: a documentação deixa de ser uma tarefa "chata" para se tornar uma ferramenta estratégica de comunicação e inclusão dentro de times e comunidades.
Elige una o más áreas en las que esta propuesta encaja.:Desenvolvimento Web, Comunidade, Pessoas
