Jak łatwo dodać (i uporządkować) dokumentację na swojej stronie Divi?

Opublikowany: 2017-05-23

Chcesz dodać dokumentację do jednej ze swoich witryn Divi? Dokumentacja umożliwia dostarczanie wszelkiego rodzaju pomocnych informacji swoim czytelnikom i klientom. Ale ponieważ dokumentacja jest własnym typem treści, prawdopodobnie nie chcesz mieszać treści dokumentacji ze zwykłymi postami lub stronami WordPress.

Aby pokazać, jak dodać dokumentację do WordPressa (a dokładniej do instalacji WordPressa z motywem Divi WordPress), przedstawię krótki samouczek dotyczący korzystania z nowej bezpłatnej wtyczki o nazwie DocuPress.

Co to jest DocuPress i co robi?

DocuPress to darmowe narzędzie do dodawania dokumentacji do dowolnej witryny WordPress. Został opracowany przez Roberta DeVore i zrodził się z potrzeby Roberta na lekkie narzędzie do tworzenia dokumentacji dla niektórych jego innych projektów programistycznych WordPress.

Chociaż istnieje wiele zaawansowanych rozwiązań baz wiedzy dla WordPressa, DocuPress jest pomocny, jeśli chcesz dodać do swojej witryny tylko podstawową dokumentację. To znaczy, jeśli nie potrzebujesz mnóstwa krótkich kodów i wbudowanej analityki.

Oto, co DocuPress faktycznie robi po zainstalowaniu:

  • Tworzy nowy niestandardowy typ postu Dokumentacja
  • Dodaje nową niestandardową taksonomię Kolekcje, aby podzielić dokumentację na różne kategorie.
  • Daje widżet umożliwiający łatwe wyświetlanie elementów dokumentacji na pasku bocznym lub w treści tworzonej za pomocą Divi Builder (lub innych narzędzi, które umożliwiają wyświetlanie widżetów w swoich postach).

W przyszłości Robert planuje dodać kilka podstawowych skrótów, aby zapewnić jeszcze większą elastyczność.

Jeśli chcesz zobaczyć DocuPress w akcji, możesz sprawdzić rzeczywisty przykład w dokumentacji wtyczki Robert's WP Dispensary.

Należy podkreślić, że ta wtyczka jest zupełnie nowa. Chociaż nie robi niczego szczególnie skomplikowanego, zawsze powinieneś o tym pamiętać, zanim od razu zaczniesz działać.

Jak używać DocuPress do tworzenia dokumentacji

Teraz, gdy już wiesz, co robi, oto jak możesz wykorzystać DocuPress do tworzenia dokumentacji dla własnej witryny WordPress.

Krok 1: Zainstaluj i aktywuj DocuPress

DocuPress jest dostępny za darmo w repozytorium wtyczek WordPress.org, więc możesz go zainstalować bezpośrednio z pulpitu WordPress.

dokumentacja

Po zainstalowaniu nie musisz nic konfigurować. Pamiętaj – to lekkie rozwiązanie!

Krok 2: Dodaj swoje zbiory dokumentacji

Po aktywacji DocuPress, powinieneś zobaczyć nowy niestandardowy typ postu Dokumentacja . Ale zanim zaczniesz dodawać artykuły dokumentacji, powinieneś dodać kilka kolekcji, aby skategoryzować swoje artykuły.

Aby to zrobić, przejdź do Dokumentacja → Kolekcje . Podaj szczegóły i kliknij Dodaj nową kolekcję . Działa to prawie identycznie jak kategoria zwykłego posta na WordPressie:

dodaj nową kolekcję

Dodaj tyle kolekcji, ile uważasz, że potrzebujesz, aby odpowiednio podzielić artykuły z dokumentacją.

Krok 3: Dodaj swoje artykuły dokumentacji

Gdy masz już swoje kolekcje, przejdź do Dokumentacja → Dodaj nowy, aby dodać aktualne artykuły z dokumentacją. Jest to prawie normalny edytor WordPressa, z wyjątkiem jednego kluczowego dodatku.

Nadaj artykułowi tytuł i wprowadź treść posta. Następnie wybierz swoją kolekcję, tak jak kategorię dla zwykłego posta na WordPressie.

Jedyną nową rzeczą, którą musisz zrobić, to wybrać Atrybuty artykułu → Kolejność w prawym dolnym rogu. To definiuje kolejność, w jakiej Twoje artykuły są wyświetlane w widżecie. Na przykład:

  • 0 wyświetla się jako pierwszy
  • 1 jest następny na liście
  • I tak dalej.

artykuły dokumentacyjne

Następnie upewnij się, że opublikowałeś swój artykuł.

Powtórz ten proces dla tylu artykułów z dokumentacją, ile potrzebujesz.

Krok 4: Wyświetl swoje zbiory dokumentacji

Po dodaniu wszystkich swoich kolekcji i artykułów możesz wyświetlić je w interfejsie użytkownika. Aby to zrobić, możesz użyć dołączonego widżetu, aby dodać wykazy dokumentacji do:

  • Twój pasek boczny
  • Treści, które tworzysz za pomocą Divi Builder (lub innego narzędzia, które umożliwia korzystanie z widżetów w treści)

Pasek boczny jest prosty – po prostu przejdź do Wygląd → Widgety i przeciągnij nad widżetem Artykuły DocuPress :

widget dokumentacji

Możesz wybrać:

  • Tytuł wyświetlany nad listą artykułów z dokumentacją
  • Ile artykułów z dokumentacji do pokazania
  • Czy pokazać wszystkie kolekcje czy konkretną kolekcję
  • Czy losować kolejność artykułów?

Jeśli chcesz wyświetlać wykazy dokumentacji w treści zamiast na pasku bocznym, możesz zamiast tego użyć modułu paska bocznego Divi.

Aby to zrobić, zacznij od dodania nowego widżetu na dole obszaru widżetów:

dodaj nowy widżet

Gdy to zrobisz, pojawi się nowy obszar paska bocznego Dokumentacja , do którego możesz dodać widżet DocuPress:

pasek boczny dokumentacji

Jeśli chcesz wyświetlać różne sekcje, możesz dodać wiele widżetów DocuPress do tego paska bocznego.

Następnie przejdź do Divi Builder dla strony, do której chcesz dodać swoją dokumentację. Dodaj nowy moduł paska bocznego i wybierz utworzony przed chwilą obszar Dokumentacja :

ustawienia paska bocznego

Następnie, zakładając, że używasz konstruktora Visual , powinieneś zobaczyć kategorie dokumentacji:

kategorie dokumentacji

Podobnie jak wszystkie moduły Divi, możesz również bawić się stylami na karcie Projekt , jeśli chcesz, powiedzmy, zmienić kolor i rozmiar czcionki dla nagłówków kategorii dokumentacji:

projekt modułu divi

W razie potrzeby możesz oczywiście dodać inne moduły Divi, aby urozmaicić swoją stronę z dokumentacją. Ale to wszystko, co musisz zrobić, aby dodać podstawową funkcjonalność dokumentacji.

Jeśli chcesz dodać swoją dokumentację do strony bez Divi Builder, możesz również użyć wtyczki, takiej jak Widget Shortcode, aby móc pobrać widżet DocuPress za pomocą krótkiego kodu.

Zawijanie

Podsumowując, DocuPress to dość proste rozwiązanie do tworzenia i zarządzania dokumentacją w WordPressie. Nie oczekuj mnóstwa dzwonków i gwizdków, ale jeśli chcesz czegoś prostego i lekkiego, jest to dobra opcja.

I chociaż prawdopodobnie nie zajęłoby Ci zbyt wiele czasu, aby stworzyć coś podobnego dla siebie z niestandardowymi typami postów, w ten sposób nie musisz brudzić sobie rąk.

Jak wspomniałem, Robert planuje dodać kilka wbudowanych skrótów, więc wtyczka powinna wkrótce stać się jeszcze łatwiejsza w użyciu.

Teraz do Ciebie – co myślisz o użyciu czegoś lekkiego, takiego jak DocuPress, do dokumentacji Twojej lub Twojego klienta? Czy wolisz to podejście od niektórych bardziej zaawansowanych wtyczek dokumentacji?

Obraz miniatury artykułu autorstwa turali / shutterstock.com