Strona publiczna bazy wiedzy renderuje się z gotowego szablonu - nie trzeba nic projektować ani programować. Do ustawienia zostaje wybór szablonu i kilka rzeczy, które robią z bazy Twoją stronę: logo, opis, tytuł w przeglądarce i kod śledzenia.
Gdzie to znajdziesz
Szablon
Pole Szablon w sekcji „Jeszcze inne opcje”. Lista pokazuje szablony pasujące do rodzaju bazy - forum ma własny, prostszy układ. Nowa baza wiedzy startuje z szablonem docs. Zmiana szablonu działa od razu, bez ruszania treści, więc można zobaczyć każdy i zostać przy tym, który wygląda lepiej.
Szablon odpowiada za układ strony: nagłówek z wyszukiwarką, kafle kategorii, listę wpisów, sidebar i stopkę. Sama treść wpisów wygląda wszędzie tak samo - formatowanie bierze się z edytora.
Szablon docs układa bazę jak pomoc w aplikacji: po lewej menu, w środku treść, a po prawej spis „Na tej stronie”. Na stronie głównej menu pokazuje same kategorie. Po wejściu w kategorię albo wpis rozwija się drzewo tej kategorii głównej: jej wpisy, podkategorie i ich wpisy. Kliknięcie w rozwiniętą kategorię zwija i rozwija jej drzewo bez przeładowania strony. Strona główna ma kafle kategorii z trzema ostatnio zaktualizowanymi wpisami i linkiem Wszystkie w kategorii, który otwiera listę wpisów kategorii razem z jej podkategoriami. Pod kaflami jest pięć najnowszych i pięć najpopularniejszych wpisów z całej bazy. Pod każdym wpisem są przyciski do poprzedniej i następnej strony w kolejności z menu. Gdy kategoria ma wpis o tym samym adresie co ona, jego treść staje się stroną kategorii zamiast listy wpisów - tak wygląda baza opublikowana z pomocy w aplikacji. Ma też przełącznik trybu ciemnego w nagłówku.
W nagłówku są też linki Kategorie (lista wszystkich kategorii) i Wszystkie wpisy, a obok adres strony produktowej, jeśli go podasz. Przy każdym wpisie na liście wszystkich wpisów widać datę jego ostatniej aktualizacji. Listę da się sortować: domyślnie widać na górze ostatnio zaktualizowane, można przełączyć na ostatnio dodane albo popularne (najczęściej odwiedzane). Link Kategorie znika, gdy baza nie ma żadnej kategorii, a wpisy bez kategorii są na stronie głównej i na górze menu, przed kategoriami.
Skórka
Przy szablonie docs obok pola Szablon pojawia się pole Skórka. Skórka zmienia kolory, fonty i detale strony, ale układ i treść zostają te same. Każda skórka ma wersję jasną i ciemną - czytelnik przełącza je w nagłówku.
- Klasyczna - czysty wygląd z niebieskim akcentem,
- Aurora - nowoczesna: fiolet z różem, kolorowe gradienty w nagłówku strony głównej, półprzezroczysty pasek na górze i zaokrąglone karty,
- Editorial - jak magazyn: szeryfowe fonty, ciepłe tło w kolorze papieru, duży inicjał na początku wpisu i cienkie linie zamiast cieni,
-
Terminal - dla programistów: font o stałej szerokości, zielony akcent, siatka w tle i
nagłówki z
##jak w Markdownie, - Cyberpunk - hakerska noc: neonowy cyjan z magentą, poświata, ścięte rogi kart i futurystyczne fonty.
Przełącznik API
Gdy wpisy mają opis API, przycisk AI przy tytule strony ma w menu link API - ale tylko tam, gdzie dana strona ma opis API. Po zaznaczeniu Przełącznik API w edycji bazy menu na każdej stronie ma przełącznik API. Czytelnik przechodzi nim między dokumentacją a opisem API. Na wpisie bez opisu API przełącznik prowadzi do opisu API jego kategorii albo całej bazy.
Logo, opis, strona produktowa
- Logo - grafika w nagłówku strony; wgrywa się ją wprost na formatce,
- Opis - zdanie pod tytułem bazy, widoczne na stronie głównej,
- Strona produktowa - adres Twojej strony; pojawia się jako link w sidebarze, żeby czytelnik miał drogę powrotną z pomocy do produktu.
Opis i strona produktowa trafiają też na początek wersji markdown bazy (adres bazy z .md na
końcu, np. /kb/moja-baza.md) - tę wersję czytają asystenci AI.
Linki z wpisów do ekranów systemu
Gdy wpis opisuje, gdzie coś kliknąć w systemie, link do tego ekranu zapisz jako
app:/ścieżka, np. [Organizacja → Ustawienia](https://app.intum.pl/organize/settings){: .docs-app-link}. W polu
Adres systemu dla linków do ekranów podaj adres, pod którym Twoi użytkownicy logują się do
systemu, np. https://app.intum.pl. Czytelnik po kliknięciu trafia wtedy prosto na ten ekran
na swoim koncie, a nie na stronę bazy wiedzy. Jeśli nie jest zalogowany, najpierw widzi
logowanie (albo zakłada konto), a potem system sam otwiera ekran z linku.
Gdy pole jest puste, link prowadzi na adres Twojego konta w systemie. To wystarcza, jeśli czytelnicy pracują na tym samym koncie co Ty (np. baza wewnętrzna zespołu). Dla bazy dla klientów wpisz adres, pod którym logują się oni.
Link do ekranu systemu wygląda inaczej niż link do innego wpisu - jako niebieski kafelek ze strzałką - i otwiera się w nowej karcie, żeby czytelnik nie tracił miejsca w pomocy.
Tytuł w przeglądarce i SEO
W zakładce Ustawienia zaawansowane:
- Tytuł strony - to, co widać na karcie przeglądarki i w wynikach wyszukiwania; puste = tytuł bazy,
- Kod w sekcji head - miejsce na Google Analytics, Tag Managera, Pixela albo własny skrypt. Kod trafia do każdej strony bazy.
Za opisy pojedynczych wpisów odpowiadają pola Tytuł HTML i Opis HTML we wpisie (Nowy wpis).
Kolejność wpisów
Pole Kolejność wpisów ustawia domyślny porządek list w całej bazie: tak jak jest, od najnowszych albo od najstarszych. Pojedyncza kategoria może to nadpisać (Kategorie), a wpisy z wyższym priorytetem i tak idą na górę.
Zanim pokażesz bazę światu
Wejdź na stronę publiczną przyciskiem Podgląd i sprawdź trzy rzeczy: czy logo się ładuje, czy wyszukiwarka zwraca sensowne wyniki na hasło, którego użyłby klient, i czy strona główna nie jest pusta. Baza bez kategorii wygląda na niedokończoną, nawet gdy ma dużo wpisów.