PT | EN
Publicado dia 13 de setembro de 2022

Docsify: Simplificando a Criação de Documentações

| Tempo de leitura 6 minutos Tempo de leitura 6 minutos
Docsify: Simplificando a Criação de Documentações

Você em algum momento já observou documentações que existem em alguns sistemas ou sites, e logo após parou para pensar: como eu poderia fazer algo assim de uma forma simples, rápida e que seja tão bonita quanto? Neste artigo, iremos te mostrar em poucos passos como desenvolver algo belo e funcional utilizando o docsify.

Mas antes de começar, é importante explicar que a documentação de sistemas ou sites é, em si, qualquer material de texto que os times envolvidos no desenvolvimento utilizam para realizar o seu trabalho. Ela serve para descrever o produto digital e contribuem para o seu status de autoridade.

Para quem não conhece, o docsify nada mais é que um gerador deste tipo de documentação em tempo real, que analisa e realiza a leitura de seus arquivos markdown (extensão.md) para gerar uma documentação com templates padronizados.

Instalação do docsify

Para começar, é preciso ter o Node.js instalado em sua máquina. Nesse sentido, você pode conferir se já possui essa instalação digitando o comando $ node -v em seu terminal. Se estiver tudo certo, ele irá retornar uma mensagem como essa:

A imagem demonstra como verificar se o Node.js está instalado em sua máquina.

Após realizar a verificação, iremos instalar o docsify na máquina com o comando $ npm install docsify-cli -g:

A imagem demonstra um passo a passo de como instalar o docsify em sua máquina.

Iniciando um novo projeto com docsify

Para iniciar um novo projeto com o docsify é muito simples, basta você criar uma pasta com o nome desejado, ir até ela e executar o comando $ docsify init. No exemplo abaixo utilizamos softdesign-doc.

A imagem demonstra o passo a passo para iniciar um novo projeto com o docsify.

No local onde perguntam se queremos reescrever a pasta, apenas confirme com o ok (Y) e prossiga. Se o procedimento for um sucesso, você terá uma estrutura de arquivos igual a essa:

Nessa imagem, você acessa o exemplo prático sobre um procedimento necessário para instalar o docsify.

Por fim, entre na pasta e execute o comando $ docsify serve como solicitado para acessar o localhost pelo seu navegador. Assim, você irá visualizar o projeto rodando na porta 3000.

Configurações necessárias

Ao concluir todo o processo acima, passamos para a parte mais interessante do projeto: as configurações do docsify. Para isso, basta abrir o projeto em qualquer editor de código de sua preferência. Acesse o arquivo index.html e lá você terá todas as configurações iniciais. É nessa etapa que a mágica acontece, dentro do objeto window.$docsify:

Nessa imagem é explicado o passo a passo das configurações.

Escolhendo um tema para a documentação

Você pode muito bem criar seu próprio CSS sem problema algum, mas também é possível utilizar um tema já existente. Confira a lista. No exemplo abaixo, nós escolhemos o theme simple dark. Para importar o seu tema basta remover o atual, que por padrão está associado ao link de CSS “//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css”. Depois, é só colocar o link que você escolheu. Feito isso, basta acessar o projeto no navegador que a modificação já estará lá.

Nessa imagem, é compartilhado o passo a passo para importar o seu tema.

Importando plugins na documentação

Já escolhemos o tema desejado, agora temos que importar algumas bibliotecas JavaScript para a documentação ficar mais fluida. Separamos alguns plugins para utilizar. São eles:

  • Pagination: necessário para quando houver mais de uma página no projeto.
  • Search: plugin que realiza a busca em toda a documentação. Ideal para os usuários não precisarem acessar página por página para visualizarem apenas uma informação.
  • Copy Code: ao gerarmos os blocos de códigos, ele cria um atalho de cópia rápida de todo o conteúdo.
  • Tabs: gerador de abas para criar uma navegação entre informações na mesma seção.
  • Prism: biblioteca para ajudar na marcação e identificação da linguagem e sintaxe, que está localizada em determinado bloco de conteúdo. Nos exemplos desse artigo, utilizamos apenas JavaScript, mas você pode encontrar mais opções.

Lista para realizar a importação:

<script src=”//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js”></script>

<script src=”//unpkg.com/docsify/lib/plugins/search.min.js”></script>

<script src=”//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js”></script>

<script src=”https://cdn.jsdelivr.net/npm/docsify-tabs@1″></script>

<script src=”//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js”></script>

<script src=”//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js”></script>

Você deve realizar a importação dos scripts antes de fechar a tag </body> no arquivo index.html conforme a imagem abaixo:

Nessa imagem está a lista de importação do docsify.

Configurando os plugins da documentação

Na seção anterior apenas importamos os plugins, agora iremos realizar a configuração geral. Para isso, você irá adicionar as seguintes opções no window.$docsify:

Nessa imagem, você encontra o passo a passo da configuração de plugins.

Nesse momento, você deve estar se perguntando para que serve cada uma delas, certo? Mantenha a calma, pois já iremos te explicar.

  • HomePage: é para onde será apontado a página inicial do seu projeto, por default ela fica no arquivo README.md da raiz.
  • LoadSideBar: precisamos desse booleano para renderizar nosso menu lateral.
  • RouterMode: adicionado para não ficar a famosa hashtag na url da documentação.
  • Name/NameLink: nome e url de redirecionamento que será renderizado no menu lateral.
  • Auto2top: volta sempre para o início da página.
  • Pagination: como o próprio nome já diz, é um plugin para paginação.
  • Search: nosso plugin de busca. Possui a mesma função do pagination, mas é preciso fazer algumas modificações.
  • Tabs: é o tipo de tema que queremos renderizar as abas. Neste caso, escolhemos material design.

Após realizar todas essas mudanças, nossa documentação com docsify está quase pronta. A etapa final é criar a estrutura de pastas e arquivos.

Como criar a estrutura de pastas para a documentação

O primeiro passo é deletar o arquivo README.md que temos na raiz do projeto. Depois, criaremos as pastas components e pages. Dentro de components adicionaremos o arquivo sidebar.md, e na pages criaremos os arquivos home.md e about.md. Sua estrutura deve ficar exatamente assim:

Nessa imagem, você irá compreender como criar a estrutura de pastas.

O segundo passo é abrir o sidebar e criar o menu lateral, como na imagem abaixo:

Nessa imagem, compartilhamos como criar o menu lateral.

Essa configuração irá renderizar um menu chamado Começando e seus sub-menus Início e Sobre. Na página about, iremos apenas renderizar um título:

Nessa imagem, você irá compreender como renderizar o menu Começando.

E na home, iremos colocar um pouco mais de informações como, por exemplo, as tabs e o copy:

Nessa imagem, está o passo a passo de como adicionar informações no docsify.

Resultado

Já que você chegou até aqui, o mínimo que espera é ver o resultado. Então, se prepare que lá vai:

Se você precisa de ajuda para desenvolver soluções digitais, nosso time de desenvolvedores está pronto para te ajudar a criar produtos inovadores. Entre em contato com nossos especialistas por meio do formulário abaixo:

Vamos conversar?

Entre em contato e vamos conversar sobre seus desafios de TI.

   

Foto do autor

Niag Alves

Desenvolvedor Front-End na SoftDesign. Apaixonado por tecnologia e inovação. Graduado em Análise e Desenvolvimento de Sistemas, atuando há mais de cinco anos com projetos voltados para web.

Quer saber mais sobre
Design, Estratégia e Tecnologia?