So fügen Sie Ihrer Divi-Website ganz einfach Dokumentation hinzu (und organisieren)

Müssen Sie einer Ihrer Divi-Websites Dokumentation hinzufügen? Mit der Dokumentation können Sie Ihren Lesern und Kunden alle Arten von hilfreichen Informationen zur Verfügung stellen. Da es sich bei der Dokumentation jedoch um einen eigenen Inhaltstyp handelt, möchten Sie wahrscheinlich keine Dokumentationsinhalte mit regulären WordPress-Posts oder -Seiten vermischen.

Um Ihnen also zu zeigen, wie Sie eine Dokumentation zu WordPress hinzufügen (und insbesondere zu einer WordPress-Installation, auf der das Divi WordPress-Theme ausgeführt wird), gebe ich Ihnen ein kurzes Tutorial zur Verwendung eines neuen kostenlosen Plugins namens DocuPress.

Was ist DocuPress und was macht es?

DocuPress ist ein kostenloses Tool zum Hinzufügen von Dokumentation zu jeder WordPress-Site. Es wurde von Robert DeVore entwickelt und entstand aus Roberts Bedarf an einem leichtgewichtigen Dokumentationstool für einige seiner anderen WordPress-Entwicklungsprojekte.

Obwohl es viele leistungsstarke Wissensdatenbanklösungen für WordPress gibt, ist DocuPress hilfreich, wenn Sie Ihrer Website nur grundlegende Dokumentation hinzufügen möchten. Das heißt, wenn Sie nicht jede Menge Shortcodes und integrierte Analysen benötigen.

So macht DocuPress bei der Installation:

• Erstellt einen neuen benutzerdefinierten Beitragstyp für die Dokumentation
• Fügt eine neue benutzerdefinierte Taxonomie für Sammlungen hinzu , um Ihre Dokumentation in verschiedene Kategorien zu unterteilen.
• Bietet Ihnen ein Widget, mit dem Sie auf einfache Weise Dokumentationselemente in Ihrer Seitenleiste oder in den Inhalten anzeigen können, die Sie mit dem Divi Builder (oder anderen Tools, mit denen Sie Widgets in Ihren Beiträgen anzeigen können) erstellen.

Für die Zukunft plant Robert, einige grundlegende Shortcodes hinzuzufügen, um Ihnen noch mehr Flexibilität zu geben.

Wenn Sie DocuPress in Aktion sehen möchten, können Sie sich ein reales Beispiel in der Dokumentation zu Roberts WP Dispensary-Plugin ansehen.

Wir sollten betonen, dass dieses Plugin brandneu ist. Obwohl es nichts besonders Komplexes macht, sollten Sie diesen Gedanken immer noch im Auge behalten, bevor Sie sofort All-in gehen.

So verwenden Sie DocuPress zum Erstellen von Dokumentationen

Jetzt, da Sie wissen, was es tut, können Sie DocuPress verwenden, um Dokumentation für Ihre eigene WordPress-Site zu erstellen.

Schritt 1: Installieren und aktivieren Sie DocuPress

DocuPress ist kostenlos im WordPress.org-Plugin-Repository verfügbar, sodass Sie es direkt von Ihrem WordPress-Dashboard installieren können.

Nach der Installation müssen Sie nichts mehr konfigurieren. Denken Sie daran – dies ist eine leichte Lösung!

Schritt 2: Fügen Sie Ihre Dokumentationssammlungen hinzu

Sobald Sie DocuPress aktivieren, sollten Sie einen neuen benutzerdefinierten Beitragstyp für die Dokumentation sehen . Bevor Sie jedoch mit dem Hinzufügen von Dokumentationsartikeln beginnen, sollten Sie einige Sammlungen hinzufügen, um Ihre Artikel zu kategorisieren.

Gehen Sie dazu zu Dokumentation → Sammlungen . Geben Sie die Details ein und klicken Sie auf Neue Sammlung hinzufügen . Dies funktioniert ziemlich identisch mit einer Kategorie für einen normalen WordPress-Beitrag:

Fügen Sie so viele Sammlungen hinzu, wie Sie Ihrer Meinung nach benötigen, um Ihre Dokumentationsartikel angemessen aufzuteilen.

Schritt 3: Fügen Sie Ihre Dokumentationsartikel hinzu

Sobald Sie Ihre Sammlungen haben, gehen Sie zu Dokumentation → Neu hinzufügen, um aktuelle Dokumentationsartikel hinzuzufügen. Dies ist so ziemlich der normale WordPress-Editor, außer mit einem zusätzlichen Schlüssel.

Geben Sie Ihrem Artikel einen Titel und geben Sie den Inhalt des Beitrags ein. Wählen Sie dann Ihre Sammlung wie eine Kategorie für einen normalen WordPress-Beitrag aus.

Neu müssen Sie lediglich unten rechts die Artikelattribute → Bestellung auswählen. Dies definiert die Reihenfolge, in der Ihre Artikel im Widget angezeigt werden. Zum Beispiel:

• 0 wird zuerst angezeigt
• 1 steht als nächstes auf der Liste
• Und so weiter.

Stellen Sie dann sicher, dass Sie Ihren Artikel veröffentlichen.

Wiederholen Sie den Vorgang für so viele Dokumentationsartikel, wie Sie benötigen.

Schritt 4: Zeigen Sie Ihre Dokumentationssammlungen an

Nachdem Sie alle Ihre Sammlungen und Artikel hinzugefügt haben, können Sie sie im Frontend anzeigen. Dazu können Sie das mitgelieferte Widget verwenden, um Dokumentationslisten hinzuzufügen zu:

• Ihre Seitenleiste
• Inhalte, die Sie mit dem Divi Builder erstellen (oder einem anderen Tool, mit dem Sie Widgets in Ihren Inhalten verwenden können)

Die Seitenleiste ist einfach – gehen Sie einfach zu Aussehen → Widgets und ziehen Sie über das DocuPress-Artikel- Widget:

Du kannst wählen:

• Der Titel, der über der Liste der Dokumentationsartikel angezeigt wird
• Wie viele Dokumentationsartikel sollen angezeigt werden
• Ob alle Kollektionen oder eine bestimmte Kollektion angezeigt werden sollen
• Ob die Artikelreihenfolge randomisiert werden soll oder nicht

Wenn Sie Ihre Dokumentationslisten in Ihren Inhalten anstelle Ihrer Seitenleiste anzeigen möchten, können Sie stattdessen das Seitenleistenmodul von Divi verwenden.

Fügen Sie dazu zunächst ein neues Widget am unteren Rand des Widgets-Bereichs hinzu:

Sobald Sie dies getan haben, haben Sie einen neuen Seitenleistenbereich für die Dokumentation , zu dem Sie das DocuPress-Widget hinzufügen können:

Wenn Sie verschiedene Abschnitte anzeigen möchten, können Sie dieser Seitenleiste mehrere DocuPress-Widgets hinzufügen.

Gehen Sie dann zum Divi Builder für die Seite, zu der Sie Ihre Dokumentation hinzufügen möchten. Fügen Sie ein neues Sidebar-Modul hinzu und wählen Sie den soeben erstellten Dokumentationsbereich aus:

Angenommen, Sie verwenden den Visual Builder, sollten Ihre Dokumentationskategorien angezeigt werden:

Wie bei allen Divi-Modulen können Sie auch im Design- Tab mit dem Styling herumspielen, wenn Sie beispielsweise die Schriftfarbe und -größe für die Überschriften der Dokumentationskategorien ändern möchten:

Und Sie können natürlich nach Bedarf weitere Divi-Module hinzufügen, um Ihre Dokumentationsseite aufzupeppen. Aber das ist alles, was Sie tun müssen, um die grundlegende Dokumentationsfunktionalität hinzuzufügen.

Wenn Sie Ihre Dokumentation zu einer Seite ohne Divi Builder hinzufügen müssen, können Sie auch ein Plugin wie Widget Shortcode verwenden, um das DocuPress-Widget über einen Shortcode einzubinden.

Einpacken

Alles in allem ist DocuPress eine ziemlich einfache Lösung zum Erstellen und Verwalten von Dokumentationen in WordPress. Erwarten Sie nicht jede Menge Schnickschnack, aber wenn Sie nur etwas Einfaches und Leichtes wollen, ist es eine gute Option.

Und obwohl Sie wahrscheinlich nicht allzu lange brauchen würden, um mit benutzerdefinierten Beitragstypen etwas Ähnliches für sich selbst zu erstellen, müssen Sie sich auf diese Weise nicht die Hände schmutzig machen.

Wie ich bereits erwähnt habe, plant Robert, einige eingebaute Shortcodes hinzuzufügen, sodass das Plugin bald noch einfacher zu verwenden sein sollte.

Nun zu Ihnen – was halten Sie davon, etwas Leichtgewichtiges wie DocuPress für Ihre Dokumentation oder die Dokumentation Ihres Kunden zu verwenden? Ziehen Sie diesen Ansatz einigen der leistungsstärkeren Dokumentations-Plugins da draußen vor?

Miniaturansicht des Artikels von turali / shutterstock.com