Como Gerar e Servir a Documentação

Este guia explica como instalar o mdbook, integrar com o JotDown, e gerar a documentação do NotionAiAssistant localmente.

Instalação do mdbook

O mdbook é uma ferramenta escrita em Rust que gera lindos livros a partir de arquivos Markdown.

Instalação via Cargo (Gerenciador de Pacotes Rust)

Se você já tem o Rust e Cargo instalados:

cargo install mdbook

Instalação via Binários Pré-compilados

Alternativamente, você pode baixar binários pré-compilados da página de releases do mdbook.

Verificação da Instalação

Para verificar se o mdbook foi instalado corretamente:

mdbook --version

Integração com JotDown

Para um fluxo de trabalho perfeito entre o Notion e nossa documentação MDBook, usamos o JotDown:

Configurando o JotDown

  1. Instale o JotDown a partir do repositório:

    git clone https://github.com/Harry-027/JotDown
    cd JotDown
    cargo build --release
    
  2. Configure seu token de API do Notion:

    export NOTION_TOKEN="seu_token_de_integracao_notion"
    
  3. Execute o JotDown para sincronizar o conteúdo do Notion com sua pasta de documentação:

    ./target/release/JotDown
    

Fluxo de Trabalho Automatizado de Documentação

Nosso fluxo de trabalho combina Notion, JotDown e MDBook:

  1. Escreva e organize o conteúdo no Notion
  2. Use o JotDown para converter páginas do Notion em arquivos Markdown
  3. O JotDown organiza automaticamente o conteúdo na estrutura do seu MDBook
  4. Gere a documentação final com mdbook

Gerando a Documentação

Construir o Livro

Para gerar os arquivos HTML estáticos:

cd /caminho/para/NotionAiAssistant/docs
mdbook build

Os arquivos serão gerados na pasta book/ dentro do diretório docs/.

Servir Localmente

Para iniciar um servidor local que atualize automaticamente quando os arquivos forem alterados:

cd /caminho/para/NotionAiAssistant/docs
mdbook serve

Isso iniciará um servidor web local, geralmente na porta 3000. Você pode acessar a documentação em: http://localhost:3000

Opções Adicionais

  • Para especificar uma porta diferente:

    mdbook serve --port 8000
    
  • Para gerar e servir sem abrir o navegador automaticamente:

    mdbook serve --open false
    

Atualizando a Documentação

  1. Atualize o conteúdo no Notion
  2. Execute o JotDown para sincronizar as alterações com seus arquivos Markdown locais
  3. Se você estiver usando mdbook serve, as alterações serão refletidas automaticamente
  4. Se você estiver usando mdbook build, execute o comando novamente para regenerar os arquivos

Estrutura de Arquivos

  • SUMMARY.md: Define a estrutura do livro e o sumário
  • book.toml: Configuração do mdbook
  • Outros arquivos .md: Conteúdo da documentação

Dicas para Contribuição

  • Mantenha a formatação consistente
  • Use imagens otimizadas para web
  • Teste a documentação localmente antes de fazer commit
  • Mantenha a navegação lógica no arquivo SUMMARY.md
  • Use o Notion para criação colaborativa de conteúdo, depois sincronize com o JotDown

Troubleshooting

Problemas Comuns

  1. Erro "Command not found":

    • Verifique se o mdbook está instalado e no seu PATH
  2. Erro ao construir:

    • Verifique se os links para imagens e outros recursos estão corretos
    • Verifique se não há erros de sintaxe Markdown
  3. Imagens não aparecem:

    • Verifique os caminhos relativos nas referências de imagens
  4. Problemas de sincronização com JotDown:

    • Verifique se seu token de API do Notion está correto
    • Certifique-se de que você tem as permissões adequadas no Notion
    • Verifique se os limites de taxa da API do Notion estão afetando sua sincronização

Para mais ajuda, consulte a documentação oficial do mdbook e o repositório do JotDown.