Como adicionar (e organizar) facilmente a documentação no site da Divi

Precisa adicionar documentação a um de seus sites Divi? A documentação permite que você forneça todos os tipos de informações úteis aos seus leitores e clientes. Mas como a documentação é seu próprio tipo de conteúdo, você provavelmente não quer misturar o conteúdo da documentação com postagens ou páginas regulares do WordPress.

Então, para mostrar a você como adicionar documentação ao WordPress (e, mais especificamente, a uma instalação do WordPress executando o tema Divi WordPress), vou lhe dar um rápido tutorial sobre como usar um novo plugin gratuito chamado DocuPress.

O que é DocuPress e o que ele faz?

DocuPress é uma ferramenta gratuita para adicionar documentação a qualquer site WordPress. Foi desenvolvido por Robert DeVore e nasceu da necessidade de Robert de uma ferramenta de documentação leve para alguns de seus outros projetos de desenvolvimento WordPress.

Embora existam muitas soluções de base de conhecimento de serviço pesado para WordPress, o DocuPress é útil se você estiver apenas procurando adicionar alguma documentação básica ao seu site. Ou seja, se você não precisa de muitos códigos de acesso e análises integradas.

Aqui está o que o DocuPress realmente faz quando você o instala:

• Cria um novo tipo de postagem personalizada de documentação
• Adiciona uma nova taxonomia customizada de Coleções para dividir sua documentação em diferentes categorias.
• Oferece um widget que permite exibir facilmente itens de documentação em sua barra lateral ou no conteúdo que você constrói com o Divi Builder (ou outras ferramentas que permitem exibir widgets dentro de suas postagens).

No futuro, Robert tem planos de adicionar alguns códigos de acesso básicos para dar a você ainda mais flexibilidade.

Se quiser ver o DocuPress em ação, você pode verificar um exemplo do mundo real na documentação do plugin Robert's WP Dispensary.

Devemos ressaltar que este plugin é novo. Embora não esteja fazendo nada especialmente complexo, você deve sempre manter isso em mente antes de apostar tudo imediatamente.

Como usar o DocuPress para criar documentação

Agora que você sabe o que ele faz, veja como você pode realmente usar o DocuPress para criar documentação para seu próprio site WordPress.

Etapa 1: instalar e ativar o DocuPress

O DocuPress está disponível gratuitamente no repositório de plug-ins do WordPress.org, para que você possa instalá-lo diretamente do painel do WordPress.

Depois de instalado, não há nada que você precise configurar. Lembre-se - esta é uma solução leve!

Etapa 2: adicione suas coleções de documentação

Depois de ativar o DocuPress, você verá um novo tipo de postagem personalizada de Documentação . Mas antes de começar a adicionar artigos de documentação, você deve adicionar algumas coleções para categorizar seus artigos.

Para fazer isso, vá para Documentação → Coleções . Preencha os detalhes e clique em Adicionar nova coleção . Isso funciona de forma praticamente idêntica a uma categoria para uma postagem normal do WordPress:

Adicione quantas coleções você acha que precisa para dividir adequadamente seus artigos de documentação.

Etapa 3: adicione seus artigos de documentação

Assim que tiver suas coleções, vá para Documentação → Adicionar Novo para adicionar artigos de documentação reais. Este é praticamente o Editor WordPress normal, exceto com uma adição de chave.

Dê um título ao seu artigo e insira o conteúdo da postagem. Em seguida, selecione sua coleção como se fosse uma categoria para uma postagem normal do WordPress.

A única coisa nova que você precisa fazer é escolher Atributos de artigo → Ordem no canto inferior direito. Isso define a ordem em que seus artigos são exibidos no widget. Por exemplo:

• 0 exibe primeiro
• 1 é o próximo na lista
• E assim por diante.

Então, certifique-se de publicar seu artigo.

Repita o processo para quantos artigos de documentação forem necessários.

Etapa 4: Exibir suas coleções de documentação

Depois de adicionar todas as suas coleções e artigos, você está pronto para exibi-los no front-end. Para fazer isso, você pode usar o widget incluído para adicionar listagens de documentação a:

• Sua barra lateral
• Conteúdo que você cria com o Divi Builder (ou outra ferramenta que permite o uso de widgets em seu conteúdo)

A barra lateral é simples - basta acessar Aparência → Widgets e arrastar sobre o widget Artigos do DocuPress :

Você pode escolher:

• O título exibido acima da lista de artigos de documentação
• Quantos artigos de documentação mostrar
• Mostrar todas as coleções ou uma coleção específica
• Se deve ou não randomizar a ordem do artigo

Se você gostaria de mostrar suas listagens de documentação em seu conteúdo em vez de sua barra lateral, você pode usar o Módulo de barra lateral do Divi.

Para fazer isso, comece adicionando um novo widget na parte inferior da área de Widgets:

Depois de fazer isso, você terá uma nova área da barra lateral de documentação à qual pode adicionar o widget DocuPress:

Se desejar exibir diferentes seções, você pode adicionar vários widgets DocuPress a esta barra lateral.

Em seguida, vá para o Divi Builder para a página à qual deseja adicionar sua documentação. Adicione um novo Módulo de barra lateral e selecione a área de documentação que você acabou de criar:

Então, supondo que você esteja usando o Construtor Visual , você deve ver as categorias da documentação:

Como todos os módulos Divi, você também pode brincar com o estilo na guia Design se quiser, digamos, alterar a cor e o tamanho da fonte para os títulos das categorias de documentação:

E você pode, é claro, adicionar outros módulos Divi conforme necessário para incrementar sua página de documentação. Mas isso é tudo que você precisa fazer para adicionar a funcionalidade de documentação central.

Se precisar adicionar sua documentação a uma página sem o Divi Builder, você também pode usar um plugin como Widget Shortcode para poder puxar o widget DocuPress por meio de um shortcode.

Empacotando

Em suma, DocuPress é uma solução bastante simples para criar e gerenciar documentação em WordPress. Não espere toneladas de sinos e assobios, mas se você quer algo simples e leve, é uma boa opção.

E embora provavelmente não demore muito para criar algo semelhante para si mesmo com tipos de postagem personalizados, dessa forma você não precisa sujar as mãos.

Como mencionei, Robert tem planos de adicionar alguns códigos de acesso integrados, portanto, o plug-in deve se tornar ainda mais fácil de usar.

Agora é sua vez - o que você acha de usar algo leve como o DocuPress para sua documentação ou a de seu cliente? Você prefere essa abordagem para alguns dos plug-ins de documentação mais pesados ​​que existem?

Imagem em miniatura do artigo por turali / shutterstock.com