just the docs

Apenas os documentos

Um tema Jekyll moderno, altamente personalizável e responsivo para documentação com pesquisa integrada.
Facilmente hospedado em páginas do GitHub com poucas dependências.

Veja-o em ação!

Um vídeo passo a passo de vários recursos do Just the Docs

just-the-docs-features-walkthrough.mp4

Instalação

Use o modelo

O modelo Just the Docs fornece a maneira mais simples, rápida e fácil de criar um novo site que usa o tema Just the Docs. Para começar a criar um site, basta clicar em “usar o modelo”!

Observação: para usar o tema, você não precisa clonar ou bifurcar o repositório Just the Docs! Você deve fazer isso apenas se pretende navegar localmente pelos documentos do tema, contribuir para o desenvolvimento do tema ou desenvolver um novo tema baseado no Just the Docs.

Você pode facilmente definir o site criado pelo modelo para ser publicado nas páginas do GitHub – o arquivo README do modelo explica como fazer isso, junto com outros detalhes.

Se o Jekyll estiver instalado no seu computador, você também poderá criar e visualizar o site criado localmente . Isso permite testar as alterações antes de confirmá-las e evita esperar pelas páginas do GitHub. ¹ E você poderá implantar sua compilação local em uma plataforma diferente do GitHub Pages.

Mais especificamente, o site criado:

• usa uma abordagem baseada em gem, ou seja, usa um Gemfile e carrega a gem just-the-docs
• usa o fluxo de trabalho GitHub Pages/Actions para construir e publicar o site no GitHub Pages

Fora isso, você pode personalizar os sites que criar com o modelo, como quiser. Você pode alterar facilmente as versões do just-the-docs e do Jekyll que ele usa, bem como adicionar outros plug-ins.

Usar RubyGems

Alternativamente, você pode instalar o tema como Ruby Gem, sem criar um novo site.

Adicione esta linha ao Gemfile do seu site Jekyll:

 gem "just-the-docs"

E adicione esta linha ao _config.yml do seu site Jekyll:

 theme : just-the-docs

E então execute:

 $ bundle

Ou instale você mesmo como:

 $ gem install just-the-docs

Alternativamente, você pode executá-lo dentro do Docker enquanto desenvolve seu site

 $ docker-compose up

Uso

Consulte a documentação para obter informações de uso.

Contribuindo

Relatórios de bugs, propostas de novos recursos e solicitações pull são bem-vindos no GitHub em https://github.com/just-the-docs/just-the-docs. Este projeto pretende ser um espaço seguro e acolhedor para colaboração, e espera-se que os contribuidores sigam o código de conduta do Contributor Covenant.

Enviando alterações de código:

• Envie um problema que motive as mudanças, usando o modelo apropriado
• Discuta as mudanças propostas com outros usuários e mantenedores
• Abra uma solicitação pull
• Garanta que todos os testes de CI sejam aprovados
• Forneça instruções para verificar o efeito das alterações
• Aguarde revisão do código

Princípios de design e desenvolvimento deste tema:

1. Menos dependências possíveis
2. Nenhum script de construção necessário
3. Experiência móvel de primeira classe
4. Faça o conteúdo brilhar

Desenvolvimento

Para configurar seu ambiente para desenvolver este tema: bifurque este repositório, execute a bundle install a partir do diretório raiz.

Uma configuração moderna de devcontainer para VSCode está incluída.

Seu tema é configurado como um site normal do Jekyll! Para testar seu tema, execute bundle exec jekyll serve e abra seu navegador em http://localhost:4000 . Isso inicia um servidor Jekyll usando seu tema. Adicione páginas, documentos, dados, etc. normalmente para testar o conteúdo do seu tema. À medida que você faz modificações em seu tema e conteúdo, seu site será regenerado e você deverá ver as alterações no navegador após uma atualização, normalmente.

Quando este tema for lançado, apenas os arquivos _layouts , _includes e _sass rastreados com Git serão incluídos na gem.

Licença

O tema está disponível como código aberto sob os termos da licença MIT.

Notas de rodapé

1. Pode levar até 10 minutos para que as alterações em seu site sejam publicadas depois de enviá-las ao GitHub. ↩