Blume: Nowy framework dokumentacji open-source od eksperta OpenAI, gotowy na AI

Hayden Bleasel, doświadczony deweloper z OpenAI, zaprezentował Blume – nowy, otwarty framework do tworzenia dokumentacji. Narzędzie, które trafiło do repozytorium npm w wersji 1.0.3, ma za zadanie maksymalnie uprościć proces publikacji dokumentacji: wystarczy umieścić pliki Markdown w folderze, aby wygenerować gotową stronę, bez potrzeby pisania czy utrzymywania kodu boilerplate'u. Projekt jest dostępny na licencji MIT.

Architektura i działanie Blume

Blume to narzędzie wiersza poleceń (CLI) połączone z biblioteką komponentów, które przetwarza foldery zawierające pliki Markdown lub MDX. Na ich podstawie generuje kompletną stronę dokumentacji, oferującą nawigację, wyszukiwanie, motywy graficzne oraz obrazy Open Graph. Konfiguracja jest opcjonalna i dodawana stopniowo, w miarę potrzeb. Całość jest monorepo w TypeScript, a opublikowany pakiet znajduje się w packages/blume. Co ciekawe, własna dokumentacja Blume, umieszczona w apps/docs, została zbudowana przy użyciu samego frameworka. Wymaga Node.js w wersji 22.12 lub nowszej i działa z menedżerami pakietów takimi jak Bun, pnpm, npm czy yarn.

Pod maską, Blume generuje i zarządza ukrytym projektem Astro. Proces rozpoczyna się od wczytania pliku blume.config.ts przez CLI, a następnie skanowania treści i tworzenia grafu. Następnie, projekt Astro jest zapisywany w katalogu .blume/. Astro renderuje każdą stronę za pośrednictwem pojedynczej, uniwersalnej trasy, która importuje komponenty Blume, wygenerowane dane oraz ewentualne nadpisania użytkownika. Przy każdym uruchomieniu katalog .blume/ jest regenerowany, a tylko zmienione pliki są nadpisywane, co zapewnia szybkie przeładowywanie (hot reload) podczas edycji. Podstawowy motyw nie zawiera żadnego kodu JavaScript po stronie klienta, co przekłada się na wysokie wyniki w Core Web Vitals. Dla użytkowników potrzebujących pełnej kontroli, komenda blume eject pozwala na przekształcenie środowiska uruchomieniowego w samodzielną aplikację Astro, która nadal zależy od pakietu blume.

Łatwość konfiguracji i integracja z AI

Instalacja Blume jest niezwykle prosta i wymaga tylko jednej komendy: npx blume init. Następnie, blume dev uruchamia serwer z hot reloadingiem, a blume build generuje statyczne pliki HTML i lokalny indeks wyszukiwania do katalogu dist/. Plik konfiguracyjny, napisany w TypeScript, jest walidowany przez schemat, co pozwala na wykrywanie błędów jeszcze przed kompilacją. Przykładowa konfiguracja może obejmować źródła treści takie jak lokalne pliki (filesystem) czy bazy danych Notion.

Blume został zaprojektowany nie tylko z myślą o ludzkich czytelnikach, ale także o agentach AI. Każda strona może zwrócić surowy Markdown po dodaniu .md do adresu URL. Specjalna flaga umożliwia wygenerowanie plików llms.txt i llms-full.txt przeznaczonych dla agentów. Dodatkowo, każdą stronę można skopiować jako Markdown lub otworzyć bezpośrednio w narzędziach takich jak ChatGPT, Claude czy v0. Opcjonalny asystent AI na stronie może odpowiadać na pytania czytelników, wykorzystując AI SDK poprzez **Vercel AI Gateway

Źródło: marktechpost.com