Professor Lopes

Apresentação

Este site está sendo criado e constantemente atualizado graças às excelentes, fantásticas e gratuitas ferramentas MkDocs, GitHub, GitHub Pages, além da utilização do tema Material, construído especificamente para os utilizadores do MkDocs. Se você estiver seriamente interessado em construir seu próprio site de forma simples, a fim de preocupar-se apenas com o conteúdo a ser publicado, pode acreditar, este é um ótimo caminho!

MkDocs

Veja alguns tópicos traduzidos da primeira página de sua home page:

Visão geral

O MkDocs é um gerador de site estável, rápido, simples e absolutamente original, orientado para a construção de documentação de projetos(1). Os arquivos de origem da documentação são escritos em Markdown e configurados com um único arquivo de configuração YAML.

(1) Professor Lopes: Rapidamente você perceberá que pode utilizar esta construção para escrever seus artigos (científicos ou não) e outras formas de publicação, com a mesma facilidade.

Hospede em qualquer lugar

O MkDocs cria sites em HTML completamente estáticos que você pode hospedar nas páginas do GitHub, Amazon S3 ou em qualquer outro lugar que você escolher.

Ótimos temas disponíveis

Há uma coleção de temas de boa aparência disponíveis para o MkDocs. Escolha entre os temas incorporados: mkdocs ou readthedocs, selecione um dos temas de terceiros no wiki MkDocs, ou crie o seu próprio.

Visualize seu site enquanto trabalha

O built-in dev-server permite visualizar sua documentação conforme você está escrevendo. Até recarregará automaticamente e atualizará seu navegador, sempre que você salvar suas alterações.

Fácil de personalizar

Escreva a documentação do seu projeto exatamente do jeito que quiser, personalizando o tema.

Criando e construindo suas publicações

Depois de instalado, basta criar, no local que quiser, uma pasta e nomeá-la. Abra seu terminal de comando preferido (cmd, powershell, entre outros) nesta pasta criada, siga as instruções e, com os comandos abaixo, seu site estará iniciado e pronto para publicação. Após isso, pode personalizá-lo como lhe convier, além, é evidente, de iniciar suas criações e publicações.

• mkdocs new [dir-name] - Crie um novo projeto.
• mkdocs serve - Inicie o servidor de recarregamento do documento, em tempo real.
• mkdocs build - Construa o site de documentação.
• mkdocs help - Imprima esta mensagem de ajuda.

Formatando suas publicações

mkdocs.yml    # O arquivo de configuração.
docs/
    index.md # A página inicial da documentação.
    ...      # Outras páginas em markdown, imagens e outros arquivos.