Blume

Mis on Blume?

Blume on avatud lähtekoodiga dokumentatsiooniplatvorm, mis muudab tavalise Markdowni tootmiskõlbulikuks dokumentatsioonisaidiks. See on loodud meeskondadele, kes soovivad avaldada ilusat, kiiret ja AI-valmis dokumentatsiooni ilma rakenduse boilerplate’i kirjutamise või hooldamiseta. Lisa Blume’i kaust Markdowni faile ja see tegeleb ülejäänuga — otsing, kujundus, SEO ja ühe käsuga juurutused Astro ja Vite abil. Tasuta ja avatud lähtekoodiga, igavesti.

Kellele see on mõeldud

• Arenduskogemuse juhid — kes peavad avaldama ja haldama dokumentatsiooni mitme toote jaoks ilma spetsiaalse dokumentatsiooni insenerimeeskonnata.
• API- ja SDK-meeskonnad — kes soovivad interaktiivseid viiteid ja muudatuste logisid, mis genereeritakse otse OpenAPI spetsifikatsioonidest ja GitHub Releases’ist.
• Avatud lähtekoodiga haldajad — kes soovivad nullkonfiguratsiooniga tasuta dokumentatsioonisaidi, mis püsib sünkroonis nende repositooriumiga ja juurutatakse ühe käsuga.

Peamised funktsioonid

Nullkonfiguratsiooniga seadistus

Kaust Markdowni on täielik projekt — pole vaja kloonida stardikomplekti ega hoida malli ülemvooluga sünkroonis. Navigeerimine tuletatakse sinu failidest ning otsing, kujundus ja OG-pildid on vaikimisi sisse lülitatud. Konfiguratsiooni kasutad ainult siis, kui seda tegelikult vajad.

Interaktiivsed API-viited

Lisa OpenAPI või AsyncAPI spetsifikatsioon ja Blume renderdab täieliku interaktiivse viite — lõpp-punktid, skeemid ja reaalajas "Proovi" mänguväljak. See töötab Scalar’i toel ja on kujundatud sinu saidiga sobivaks, nii et sinu API-dokumentatsioon tunneb end toote osana, mitte järelmõttena.

Sisseehitatud muudatuste logi

Kirjuta iga väljalase Markdowni kirjena — või suuna Blume oma GitHub Releases’ile — ja kõik need koondatakse genereeritud ajajoonele /changelog aadressil. Saad püsilingid, uusimad-esimesed järjestuse ja RSS-vooga vaikimisi, nii et kasutajad saavad sinu uuendusi tellida.

AI-valmis ja i18n kohe karbist välja

Blume’il on täistekstotsing, tume režiim ja tugi 36 keelele (i18n) — kõik ilma pluginat installimata või teenust ühendamata. AI-valmis alus tähendab, et sinu dokumentatsioon on struktureeritud viisil, mida keelemudelitel on lihtne tarbida, mis muutub üha olulisemaks, kuna AI-assistendid muutuvad peamiseks dokumentatsiooni liideseks.

Mis paistab silma

"Kaust Markdowni on täielik projekt — pole stardikomplekti kloonida, pole malli sünkroonis hoida."

See on põhilubadus ja Blume täidab seda. Enamik dokumentatsioonitööriistu nõuab, et võtaksid kasutusele raamistiku, õpiksid kujundussüsteemi või ühendaksid tosina integratsiooni enne tulemuse nägemist. Blume pöörab selle ümber: vaikimisi kogemus on tootmiskõlbulik ja konfiguratsioon on erand, mitte reegel. Koos interaktiivsete API-viidete ja GitHub Releases’i integratsiooniga katab see API-dokumentatsiooni kogu elutsükli — kiirjuhendist muudatuste logini — ühe tööriistaga.

Tasub proovida, kui…

Oled väsinud dokumentatsioonisaidi hooldamisest kõrvalprojektina või oled alustamas uut API-d ja soovid dokumentatsiooni, mis näeb esimesest päevast viimistletud välja. Kui kirjutad juba Markdowni ja soovid otsingut, SEO-d, i18n-i ja AI-valmidust ilma boilerplate’ita, tasub Blume’ile pilk peale heita. See on eriti tugev valik meeskondadele, kes avaldavad mitut toodet, või avatud lähtekoodiga projektidele, mis vajavad dokumentatsiooni, mis püsib koodiga sünkroonis.