Utwórz statyczną stronę internetową dla dokumentacji API za pomocą Gatsby: Greenboard

Udostępnij w sieciach społecznościowych:

Zielona tablica pozwala Ci stwórz statyczną stronę dokumentacji API za pomocą Gatsby. Witryna, którą generujesz za jej pomocą, może być następnie hostowana przy użyciu usług podobnych do Netlify. Tutaj wszystko, co musisz zrobić, to wygenerować witrynę lokalnie, a następnie hostować ją za pomocą kompatybilnego hosta. Potrzebujesz tylko wiedzy na temat Node.js i odpowiednich zależności, a następnie po prostu zacznij. Wykorzystuje przeceny dla treści, które zostaną skompilowane do HTML podczas tworzenia witryny. Jeśli zamierzasz wydać API, to jest to dobre narzędzie. Zaletą będzie również to, że będziesz mógł hostować stronę z dokumentacją za darmo GitHub i Netlify.

Witryny statyczne są szybkie, wydajne i łatwe do hostowania. W rzeczywistości nie wymagają dużego przetwarzania serwera. Tutaj wszystko, co musisz zrobić, to po prostu utworzyć lokalnie stronę i przecenić, a następnie skompilować, aby wygenerować zasoby kompilacji. A te ramy Greenboard cię do diabła. Tutaj musisz tylko dodać go do folderu zależności projektu, a następnie gotowe. Istnieje kilka technicznych aspektów tego generatora strony statycznej, które można przeczytać na stronie ts GitHub.

Dokumentacja API Greenboard

Jak utworzyć statyczną stronę internetową dla dokumentacji API za pomocą Gatsby?

Greenboard oferuje takie funkcje, jak generowanie stron statycznych na podstawie znaczników, tryb ciemny, konfigurowalne, pełne funkcje Gatsby i React oraz kilka innych. Jeśli masz doświadczenie w generowaniu stron statycznych, możesz łatwo zacząć z nim korzystać. Po prostu odpalasz terminal po upewnieniu się, że masz Node.js i Yarn. Po prostu inicjujesz projekt, a następnie dodajesz wymagane zależności. W tym celu wystarczy uruchomić następujące polecenia.

cd "ProjectFolder"
yarn init
yarn add gatsby react react-dom

polecenia init przędzy

Teraz, gdy projekty są skonfigurowane, będziesz musiał dodać do niego zieloną tablicę. W tym celu musisz uruchomić następujące polecenie przędzy i poczekać, aż zakończy się. Po zakończeniu tego polecenia możesz rozpocząć tworzenie zawartości witryny z dokumentacją w systemie Markdown. Możesz utworzyć dokumentację API w „data / index.html.md”. Następnie wystarczy zapisać zmiany, a następnie gotowe.

Zobacz:   Menu Start systemu Windows 10 Oprogramowanie umożliwiające dostęp do aplikacji, dokumentów w dowolnym miejscu na ekranie

yarn add greenboard

Greenboard w akcji z markdown

Gdy wszystko będzie w porządku, strona będzie wyglądać jak pokazano na poniższym zrzucie ekranu. To jest strona dokumentacji API dla Kittn API. I możesz bardzo łatwo wygenerować własne, postępując zgodnie z tym przewodnikiem. Możesz sprawdzić oficjalne repozytorium projektów GitHub tutaj, aby zrozumieć techniczne aspekty Greenboard.

Witryna statyczna Greenboard w akcji

W ten sposób możesz łatwo wygenerować stronę statyczną, a następnie po prostu hostować ją w dowolnym miejscu. Wszystko, co musisz zrobić, to po prostu użyć frameworka Greenboard, który pomoże Ci wygenerować stronę internetową. Na koniec, po dodaniu zawartości do markdown, wystarczy uruchomić polecenie kompilacji Gatsby, a wygeneruje ona zasoby kompilacji. Możesz dodać te ustawienia w procesie kompilacji Netlify, a następnie hostować końcową stronę statyczną.

Końcowe przemyślenia

Jeśli chcesz wygenerować stronę statyczną dla dokumentacji API, musisz znaleźć się we właściwym miejscu. Używaj Gatsby w połączeniu z Greenboard, o którym wspomniałem w tym poście. Witryna z dokumentacją API różni się bardzo od zwykłych witryn, ponieważ zawiera tak wiele przykładów kodu i demonstracji. Motyw Greenboard zawiera wszystko i można go łatwo używać na komputerze do generowania witryn internetowych, które można łatwo hostować.

Komentarze Facebook