A ideia geral e buscar definir padrões para as equipes. Seja padrões de estilos de código, arquitetura de determinado framework, ou soluções para problemas comuns nas línguagens e/ou frameworks.
O tema Docsify é um sistema de tema simples para docsify.js. Apresenta vários temas com opções de personalização ricas, uma experiência de desktop e móvel aprimorada e suporte a navegador legado (IE10 +).
Links abaixo da página do tema e um preview
- Homepage - Live demo, documentation, and theme previews
- Demo Sandbox - Online editor with demo docsify-themeable site
A visualização de seu site localmente requer veicular seus arquivos de um servidor da web.
O guia de início rápido do docsify recomenda docsify-cli para criar e visualizar seu site:
instale docsify-cli globalmente
npm install -g docsify-cliServe diretório atual
docsify serveServe o diretório ./docs
docsify serve docsDeve ser criado uma nova branch a partir da develop. E depois adicinar a feature da sessão que quer ser criada, por exemplo, feature/nodejs#1.
Dentro da pasta docs, estão todos os guides criados atualmente. Com cada pasta com seu devido título.
Deve ser criada a pasta - ou se já existir, ignorar este passo -, depois criar o arquivo markdown dentro do mesmo.
Exemplo: docs/NODEJS/index.md
Após criado o arquivo, deve ser adicionado no header lateral do projeto, que fica no arquivo:
docs/sidebar.md
Após feita a alteração, solicitar pull request, para a branch main.
Este projeto está licenciado sob a Licença MIT. Consulte a LICENSE para obter detalhes.
Projeto criado baseado no docsify do Copyright (c) John Hildenbiddle (@jhildenbiddle)