Metan avoimen lähdekoodin tiimi julkaisi äskettäin Docusaurus 3.9:n, tärkeän päivityksen sen suosittuun React-pohjaiseen staattiseen sivustogeneraattoriin.
Sen uusi versio,julkistettiin 25. syyskuutaesitteli merkittävän uuden ominaisuuden: tekoälyllä toimivan hakuavustajan.
Uusien ominaisuuksien lisäksi päivitys myös modernisoi taustalla olevaa tekniikkaa, mikä edellyttää kehittäjien käyttävän Node.js 20:tä ja lopettaa tuen vanhemmalle Node.js 18:lle.
Tekoälyllä toimiva keskusteluhaku DocSearch v4:n avulla
Laajamittaista dokumentaatiota ylläpitäville kehittäjille Docusaurus 3.9:n erottuva lisäys tukee täysin Algolian DocSearch v4:ää.
Päivitys esittelee AskAI:n, ominaisuuden, joka muuttaa sivuston tavallisen hakupalkin keskusteluavustajaksi.
Avainsanojen yhdistämisen sijaan työkalu tarjoaa syntetisoituja vastauksia, jotka auttavat käyttäjiä ratkaisemaan ongelmia tehokkaammin.
Docusaurus-tiimin mukaan tavoitteena on "antaa sinun lisätä tekoälyllä toimiva hakuavustaja Docusaurus-sivustollesi, joka voi vastata kysymyksiin dokumentaatiosi perusteella keskustelukokemuksella."
Siirtyminen avainsanojen hausta keskusteluvastauksiin merkitsee suurta kehitystä teknisen dokumentaation käyttökokemuksessa.
Tämän tarkennetun haun käyttöönotto on vapaaehtoista, mikä antaa tiimeille mahdollisuuden hallita siirtymistä. Projektien ylläpitäjät voivat jatkaa DocSearch v3:ssa tai päivittää asteittain avatakseen uudet tekoälyominaisuudet.
Niille, jotka ovat valmiita ottamaan sen käyttöön, Algolia tarjoaa esteettömän sisääntulopisteen. Sen virallinen hinnoittelusivu sisältää ilmaisen "Build"-tasonsisältää 10 000 hakupyyntöä kuukaudessa, mikä tekee ominaisuudesta käyttökelpoisen avoimen lähdekoodin projekteihin ja pienempiin ryhmiin.
Tällainen integraatio heijastaa laajempaa alan suuntausta upottaa generatiivista tekoälyä suoraan kehittäjäalustoille tuottavuuden lisäämiseksi ja käyttäjien kitkan vähentämiseksi.
Säätiön modernisointi: Node.js 20 nyt vaaditaan
Turvallisuuden ja suorituskyvyn parantamiseen tähtäävänä siirtona Docusaurus 3.9 nostaa vähimmäisajoaikavaatimuksensa Node.js v20.0:aan,lopettaa virallisesti Node.js 18:n tuen.
Koska Node.js 18 on saavuttanut virallisen käyttöikänsä, se ei enää saa tietoturvapäivityksiä, mikä tekee sen jatkuvasta käytöstä mahdollisena haavoittuvuuden.
Docusauruksen tiimi pitää tätä pakollista päivitystä tärkeänä askeleena turvallisen ja vakaan alustan ylläpitämisessä.
"Node.js:n käyttöiän loppuversioiden pudottaminen pieniin versioihin on yleinen käytäntö Node.js-ekosysteemissä, jota nyt virallisesti tuemme ja dokumentoimme julkaisuprosessissamme."
Lisätietoja:Lataa Galaxy S24 & S24 Ultra Staattiset ja live-taustakuvat
Vaikka tämä päätös on paras käytäntö, se vaatii kehitystiimeiltä toimia. Sen välittömin vaikutus on CI/CD-putkistoon ja paikallisiin kehitysympäristöihin.
Käytännön esimerkki tästä ilmestyi GitHubissa, missäkehittäjä teki ongelmantoteaa, että GitHub Actionsin viralliset dokumentaatioesimerkit viittasivat edelleen vanhentuneeseen Node 18:aan, joka vaati päivityksen toimiakseen oikein.
Tiimien on tarkastettava paitsi rakennuskomentosarjansa myös Docker-tiedostonsa ja paikalliset ympäristövastaavat varmistaakseen sujuvan siirtymisen ja välttääkseen koontivirheitä.
Parannettu joustavuus maailmanlaajuisille dokumentaatiosivustoille
Vastatakseen monikielisten sivustojen pitkäaikaiseen haasteeseen, Docusaurus 3.9 tuo merkittäviä parannuksiakansainvälistymisjärjestelmä (i18n)..
Kehittäjät voivat nyt ohittaa kunkin maa-alueen baseUrl- ja url-ominaisuudet erikseen käyttämällä uutta i18n.localeConfigs[locale]-kenttää.
Se tarjoaa yksityiskohtaisen hallinnan, jota tarvitaan monimutkaisiin usean verkkotunnuksen käyttöönotuksiin – esimerkiksi englanninkielisten asiakirjojen isännöimiseen osoitteessa docs.example.com ja ranskankielisiin asiakirjoihin osoitteessa docs.example.fr varmistaen samalla, että kaikki metatiedot ja linkit ratkaistaan oikein.
Muita i18n-optimointeja ovat uusi "käännös" -lippu, joka on nyt oletuksena poistettu käytöstä sivustoilla, joissa ei ole käännöksiä, mikä nopeuttaa rakennusaikaa välttämällä tarpeettomia tiedostojärjestelmän lukuja.
Lisäksi sivupalkin kohteille voidaan määrittää uusi "avain"-attribuutti. Tämän avaimen lisääminen estää käännösavainristiriidat, kun useat luokat jakavat saman tunnisteen, kuten "API", varmistaen, että jokainen esiintymä voidaan kääntää yksilöllisesti sen kontekstin perusteella dokumentaatiorakenteessa.
Tärkeimmät päivitykset kaavioihin, suorituskykyyn ja kehittäjäkokemukseen
Otsikon ominaisuuksien lisäksi Docusaurus 3.9 sisältää joukon muita arvokkaita parannuksia.
Näihin kuuluu tuki mmMermaid ELK asettelualgoritmi.Mermaid on suosittu työkalu kaavioiden luomiseen tekstistä, ja sen ELK-asettelumoottori tarjoaa kehittyneempiä renderöintiominaisuuksia, mikä on erityisen hyödyllistä suurissa tai monimutkaisissa järjestelmäarkkitehtuurikaavioissa.
Suorituskyky paranee myös päivityksen myötäRspack 1.5,joka hyödyntää uusia konfigurointivaihtoehtoja Docusauruksen rakennusaikojen nopeuttamiseksi. Nopeammat rakenteet lisäävät suoraan kehittäjien tuottavuutta erityisesti suurissa projekteissa.
Muita merkittäviä muutoksia ovat uudet koukut rikkinäisten Markdown-linkkien käsittelyyn, mahdollisuus poistaa käytöstä emojien renderöinti ja parannettu visuaalinen vakaus vaihdettaessa väritilojen välillä.
Nämä kollektiiviset parannukset vahvistavat Docusauruksen asemaa vankana, tehokkaana ja joustavana alustana nykyaikaisten dokumentaatiosivustojen rakentamiseen.
