Blume bygger en dokumentationssajt av en enda Markdown-fil
Blume är ett verktyg som tar en Markdown-fil och genererar en färdig HTML-dokumentation av den: navigation i sidomeny, sökfunktion och en MCP-anslutning som gör dokumentationen läsbar för AI-assistenter. Inget statiskt sajtramverk att konfigurera, ingen mappstruktur att bestämma i förväg. Du skriver din dokumentation i en fil och får ut en sajt.
Målgruppen är utvecklare som har ett bibliotek, ett internverktyg eller ett API att dokumentera men som inte vill ägna en eftermiddag åt att sätta upp Docusaurus eller MkDocs för femtio sidor text.
Rubriknivåerna blir sajtens navigation
Här ligger hela idén. En vanlig dokumentationsgenerator kräver att du speglar sajtens struktur i filsystemet: en mapp per sektion, en fil per sida, ofta en konfigurationsfil som listar ordningen. Blume vänder på det och läser strukturen ur Markdown-filen i stället. Rubriknivåerna är strukturen.
En `#` blir en toppnivå, en `##` blir en undersida eller ett avsnitt i menyn och `###` hamnar i innehållsförteckningen för den sidan. Flyttar du ett avsnitt i filen, flyttas det i navigationen. Byter du namn på en rubrik, byter länken namn. Det finns ingen andra plats där strukturen också står nedskriven och därför ingen risk att de två glider ifrån varandra.
Det låter trivialt men det är precis den glidningen som gör dokumentation föråldrad. Någon lägger till en ny funktion, skriver ett avsnitt om den, glömmer registrera sidan i navigationsfilen och avsnittet existerar men går inte att hitta. Med en enda fil som sanning finns inget att glömma. Sökfunktionen indexerar samma innehåll, så en ny rubrik blir sökbar i samma sekund som den sparas.
Begränsningen är lika tydlig. En fil fungerar fint upp till några tusen rader men ett större projekt med tjugo bidragsgivare får merge-konflikter i samma dokument varje vecka. Där är flera filer inte en nackdel, utan poängen. Blume är byggt för det mindre fallet och det mindre fallet är vanligare än vad verktygsmarknaden brukar antyda.
MCP-anslutningen gör dokumentationen läsbar för AI-assistenter
MCP står för Model Context Protocol och är ett öppet protokoll för att koppla språkmodeller till externa datakällor och verktyg. Blume exponerar dokumentationen som en MCP-server, vilket betyder att en AI-assistent kan slå i den direkt i stället för att gissa utifrån träningsdata.
Skillnaden märks när du ber en assistent om hjälp med ett bibliotek som uppdaterats efter modellens kunskapsgräns. Utan tillgång till aktuell dokumentation hallucinerar den funktionsnamn som verkade rimliga för två år sedan. Med en MCP-koppling hämtar den den rubrik som faktiskt finns i filen. Samma princip som vi sett i Compose Multiplatform 1.12, där MCP låter agenter inspektera en körande app.
Ett npm-paket eller Python-bibliotek passar Blume bäst
Har du ett npm-paket, ett Python-bibliotek eller ett internt API där dokumentationen i dag ligger i en `README.md` som vuxit till 900 rader, är Blume ett direkt uppgraderingssteg. Du behåller filen och får navigation och sökning ovanpå.
Driver du däremot en produktdokumentation med versionshantering, flerspråksstöd och ett dussin skribenter, ska du inte lämna ditt nuvarande ramverk.
Verktyget hör till samma familj som GolemUI, som genererar formulär från JSON: en datakälla in, färdig struktur ut, noll konfiguration. Trenden är att generatorer slutar be om en konfigurationsfil och i stället härleder allt de behöver ur innehållet. För den som skriver dokumentation som bisyssla till själva kodningen, alltså de flesta, är det rätt riktning. Att skriva dokumentation blir aldrig roligt men det ska åtminstone inte kräva en byggkedja.