Come aggiungere (e organizzare) facilmente la documentazione sul tuo sito Web Divi

Pubblicato: 2017-05-23

Hai bisogno di aggiungere documentazione a uno dei tuoi siti web Divi? La documentazione ti consente di fornire tutti i tipi di informazioni utili ai tuoi lettori e clienti. Ma poiché la documentazione è il suo tipo di contenuto, probabilmente non vorrai mischiare il contenuto della documentazione con i normali post o pagine di WordPress.

Quindi, per mostrarti come aggiungere documentazione a WordPress (e, più specificamente, a un'installazione di WordPress che esegue il tema Divi WordPress), ti darò un breve tutorial su come utilizzare un nuovo plug-in gratuito chiamato DocuPress.

Che cos'è DocuPress e cosa fa?

DocuPress è uno strumento gratuito per aggiungere documentazione a qualsiasi sito WordPress. È sviluppato da Robert DeVore ed è nato dall'esigenza di Robert di uno strumento di documentazione leggero per alcuni dei suoi altri progetti di sviluppo di WordPress.

Sebbene ci siano molte soluzioni di knowledge base per WordPress pesanti, DocuPress è utile se stai solo cercando di aggiungere della documentazione di base al tuo sito. Cioè, se non hai bisogno di un mucchio di shortcode e analisi integrate.

Ecco cosa fa effettivamente DocuPress quando lo installi:

  • Crea un nuovo tipo di post personalizzato per la documentazione
  • Aggiunge una nuova tassonomia personalizzata di Collections per dividere la documentazione in diverse categorie.
  • Ti offre un widget che ti consente di visualizzare facilmente gli elementi della documentazione nella barra laterale o nel contenuto che crei con Divi Builder (o altri strumenti che ti consentono di visualizzare i widget all'interno dei tuoi post).

In futuro, Robert ha in programma di aggiungere alcuni shortcode di base per darti ancora più flessibilità.

Se vuoi vedere DocuPress in azione, puoi dare un'occhiata a un esempio reale nella documentazione per il plugin WP Dispensary di Robert.

Dobbiamo sottolineare che questo plugin è nuovo di zecca. Anche se non sta facendo nulla di particolarmente complesso, dovresti comunque tenerlo a mente prima di andare all-in subito.

Come utilizzare DocuPress per creare documentazione

Ora che sai cosa fa, ecco come puoi effettivamente utilizzare DocuPress per creare documentazione per il tuo sito WordPress.

Passaggio 1: installa e attiva DocuPress

DocuPress è disponibile gratuitamente nel repository dei plugin di WordPress.org, quindi puoi installarlo direttamente dalla dashboard di WordPress.

documentazione

Una volta installato, non è necessario configurare nulla. Ricorda: questa è una soluzione leggera!

Passaggio 2: aggiungi le tue raccolte di documentazione

Una volta attivato DocuPress, dovresti vedere un nuovo tipo di post personalizzato Documentazione . Ma prima di iniziare ad aggiungere articoli di documentazione, dovresti aggiungere alcune raccolte per classificare i tuoi articoli.

Per farlo, vai su Documentazione → Raccolte . Compila i dettagli e fai clic su Aggiungi nuova raccolta . Funziona praticamente in modo identico a una categoria per un normale post di WordPress:

aggiungi nuova collezione

Aggiungi tutte le raccolte che ritieni necessarie per suddividere adeguatamente i tuoi articoli di documentazione.

Passaggio 3: aggiungi i tuoi articoli di documentazione

Una volta che hai le tue raccolte, vai su Documentazione → Aggiungi nuovo per aggiungere articoli di documentazione reali. Questo è praticamente il normale editor di WordPress tranne che con un'aggiunta chiave.

Dai un titolo al tuo articolo e inserisci il contenuto del post. Quindi, seleziona la tua raccolta come faresti con una categoria per un normale post di WordPress.

L'unica cosa nuova che devi fare è scegliere Attributi articolo → Ordine in basso a destra. Questo definisce l'ordine in cui i tuoi articoli vengono visualizzati nel widget. Per esempio:

  • 0 viene visualizzato per primo
  • 1 è il prossimo della lista
  • E così via.

articoli di documentazione

Quindi, assicurati di pubblicare il tuo articolo.

Ripeti il ​​processo per tutti gli articoli di documentazione di cui hai bisogno.

Passaggio 4: mostra le tue raccolte di documentazione

Dopo aver aggiunto tutte le tue raccolte e i tuoi articoli, sei pronto per visualizzarli nel front-end. Per fare ciò, puoi utilizzare il widget incluso per aggiungere elenchi di documentazione a:

  • La tua barra laterale
  • Contenuti che crei con Divi Builder (o un altro strumento che ti consente di utilizzare i widget nei tuoi contenuti)

La barra laterale è semplice: vai su Aspetto → Widget e trascina sul widget Articoli DocuPress :

widget di documentazione

Puoi scegliere:

  • Il titolo visualizzato sopra l'elenco degli articoli della documentazione
  • Quanti articoli di documentazione mostrare
  • Se mostrare tutte le collezioni o una collezione specifica
  • Se randomizzare o meno l'ordine degli articoli

Se desideri mostrare gli elenchi della documentazione nei tuoi contenuti anziché nella barra laterale, puoi utilizzare invece il modulo barra laterale di Divi.

Per farlo, inizia aggiungendo un nuovo Widget nella parte inferiore dell'area Widget:

aggiungi un nuovo widget

Dopo averlo fatto, avrai una nuova area della barra laterale della documentazione a cui puoi aggiungere il widget DocuPress:

barra laterale della documentazione

Se desideri visualizzare sezioni diverse, puoi aggiungere più widget DocuPress a questa barra laterale.

Quindi, vai al Divi Builder per la pagina a cui vuoi aggiungere la tua documentazione. Aggiungi un nuovo modulo della barra laterale e seleziona l'area della documentazione appena creata:

impostazioni della barra laterale

Quindi, supponendo che tu stia utilizzando il generatore visivo , dovresti vedere le tue categorie di documentazione:

categorie di documentazione

Come tutti i moduli Divi, puoi anche giocare con lo stile nella scheda Design se vuoi, ad esempio, cambiare il colore e la dimensione del carattere per le intestazioni delle categorie di documentazione:

design del modulo divi

E puoi, ovviamente, aggiungere altri moduli Divi secondo necessità per rendere più piccante la tua pagina di documentazione. Ma questo è tutto ciò che devi fare per aggiungere la funzionalità di documentazione di base.

Se devi aggiungere la tua documentazione a una pagina senza Divi Builder, puoi anche utilizzare un plug-in come Widget Shortcode per poter inserire il widget DocuPress tramite uno shortcode.

Avvolgendo

Tutto sommato, DocuPress è una soluzione piuttosto semplice per creare e gestire la documentazione in WordPress. Non aspettarti tonnellate di campane e fischietti, ma se vuoi solo qualcosa di semplice e leggero, è una buona opzione.

E anche se probabilmente non ti ci vorrà troppo tempo per creare qualcosa di simile per te stesso con tipi di post personalizzati, in questo modo non hai bisogno di sporcarti le mani.

Come ho detto, Robert ha in programma di aggiungere alcuni shortcode incorporati, quindi il plugin dovrebbe presto diventare ancora più facile da usare.

Ora tocca a te: cosa ne pensi dell'utilizzo di qualcosa di leggero come DocuPress per la documentazione tua o del tuo cliente? Preferisci questo approccio ad alcuni dei plugin di documentazione più pesanti là fuori?

Immagine in miniatura dell'articolo di turali / shutterstock.com