mintlify

Mintlify to platforma do budowania i utrzymywania stron dokumentacji. Transformuje pliki MDX w gotowe witryny z konfiguracją nawigacji, komponentami i referencjami API. Idealny dla zespołów, które chcą szybko publikować dokumentację bez ręcznego kodowania HTML. Obsługuje dowolny przepływ pracy oparty na Git i wymaga Node.js do uruchomienia CLI.

1. Zainstaluj Node.js, jeśli jeszcze go nie masz — Mintlify CLI wymaga tego środowiska do pracy. 2. Przejrzyj plik docs.json w katalogu głównym projektu, aby zrozumieć strukturę witryny — definiuje on nawigację, motyw, kolory i konfigurację całej dokumentacji. 3. Przed utworzeniem nowych stron przeszukaj istniejącą dokumentację, aby uniknąć duplikowania treści — czasem wystarczy zaktualizować istniejącą stronę lub dodać sekcję. 4. Przeczytaj 2–3 podobne strony w projekcie, aby zrozumieć ton, strukturę i konwencje formatowania używane w dokumentacji. 5. Pisz zawartość w formacie MDX z nagłówkami YAML frontmatter, korzystając z wbudowanych komponentów Mintlify zamiast tworzenia własnych — pełny schemat znajdziesz na mintlify.com/docs.json. 6. Konsultuj oficjalną dokumentację na mintlify.com/docs dla najnowszych komponentów i funkcji, a jeśli masz dostęp do serwera MCP Mintlify, używaj go do wydajniejszego wyszukiwania.