xyd

xyd to framework do dokumentacji, który pozwala tworzyć profesjonalne strony dokumentacyjne bez zmagań z skomplikowanymi narzędziami. Zawiera sześć pięknych, wbudowanych motywów, których możesz od razu użyć, lub możesz dostosować każdy element, aby dopasować go do swojej marki. Framework automatycznie generuje dokumentację na podstawie specyfikacji OpenAPI, GraphQL, TypeScript i React.

W przeciwieństwie do innych narzędzi do dokumentacji, xyd zawiera wszystko, czego potrzebujesz od samego początku. Otrzymujesz pełnotekstową wyszukiwarkę z inteligentnymi sugestiami, wbudowaną analitykę do śledzenia, jak użytkownicy korzystają z twojej dokumentacji, integrację z czatem na żywo, a nawet możliwości testów A/B. Serwer deweloperski uruchamia się natychmiast z funkcją hot reload, dzięki czemu zmiany widzisz od razu. Stworzony przez programistów dla programistów, xyd eliminuje nudne elementy tworzenia dokumentacji, pozwalając skupić się na pisaniu świetnych treści.

Rozpoczęcie pracy z xyd jest proste. Oto kroki, aby stworzyć swoją dokumentację:

• Zainstaluj xyd globalnie, używając polecenia bun add -g xyd-js lub swojego ulubionego menedżera pakietów. Na komputerze musi być zainstalowana wersja Node.js 22.12 lub nowsza.

• Uruchom xyd w folderze swojego projektu, aby rozpocząć serwer deweloperski. Uruchamia się natychmiast z funkcją hot reload, co oznacza, że zmiany pojawiają się od razu bez konieczności restartu.

• Wybierz spośród sześciu wbudowanych motywów lub stwórz własny, niestandardowy design. Każdy motyw oferuje inny styl i układ, dopasowany do potrzeb Twojego projektu.

• Twórz dokumentację, korzystając z zaawansowanego frameworka treści, który obsługuje interaktywne komponenty, przykłady kodu na żywo oraz dynamiczne elementy, które sprawiają, że Twoja dokumentacja jest bardziej angażująca.

• W przypadku dokumentacji API, wystarczy wskazać xyd na specyfikacje OpenAPI, GraphQL, TypeScript lub React, a narzędzie automatycznie wygeneruje piękną dokumentację.

• Uruchom xyd build, gdy będziesz gotowy, aby stworzyć statyczne pliki do wdrożenia na dowolnej usłudze hostingowej.

• Sześć pięknych wbudowanych motywów dostępnych

• Automatyczna dokumentacja API z OpenAPI, GraphQL, TypeScript, React

• Serwer deweloperski z hot reload i zerową konfiguracją

• Pełna personalizacja wszystkich komponentów i układów

• Bogaty ekosystem wtyczek do wyszukiwania, analityki, czatu

• Interaktywne przykłady kodu i dynamiczne treści

• Wbudowana analityka i wsparcie testów A/B

• Błyskawiczna funkcjonalność pełnotekstowego wyszukiwania

• Open source i całkowicie darmowe

• Narzędzia migracyjne z innych frameworków