Rspress 2.0 väljaanne: täiustatud kogemus ja AI
Rspress 2.0 väljaanne: täiustatud kogemus ja AI
Meil on hea meel teatada Rspress 2.0 ametlikust väljaandest!
Rspress on Rsbuild-il põhinev staatiliste veebilehtede genereerija, mis on loodud dokumentatsioonilehtede tööriistaks arendajatele. Alates ametlikust väljaandest 2023. aastal on Rspress 1.x kokku läbinud 144 versiooni ja 125 panustajat on osalenud projekti arendamisel. Üha rohkem arendajaid valib Rspressi, kasutades selle efektiivset kompileerimisvõimet, kokkuleppel põhinevat marsruuti ja komponentide raamatukogu eelvaate funktsioone, et luua ilus ja usaldusväärne dokumentatsioonileht.
Kogukonna tagasiside ja soovituste põhjal on Rspress 2.0 teinud edusamme teema esteetikas, AI-native funktsionaalsuses, dokumentide arendamise kogemuses ja koos Rslibiga kasutamises.
Miks Rspress 2.0
Rspress 1.x on juba lahendanud dokumentatsioonilehtede raamistikku kompileerimise efektiivsuse probleemi, kuid endiselt on mõned probleemid, mis mõjutavad dokumentide arendamise tööriista põhikogemust. 2.0 versioon ei keskendu ainult kompileerimise efektiivsusele, vaid ka teistele dokumentatsioonilehtede kogemuse aspektidele:
- Teema stiil: uus ilusam vaiketeema, mis pakub mitmeid kohandamisvõimalusi, lahendades 1.x teema kohandamise stabiilse API puudumise probleemi.
- AI-native: dokumendid teenivad mitte ainult inimlugejat, vaid peavad olema ka Agentide poolt paremini mõistetavad ja kasutatavad. Rspress sisaldab nüüd llms.txt genereerimist ja SSG-st tuletatud SSG-MD funktsiooni, et genereerida kvaliteetset Markdowni renderdamise sisu Agentide lugemiseks.
- Nõudmisel kompileerimine, kohene käivitamine: vaikimisi on lubatud lazyCompilation, koos linkide hover'iga ressursside eelkoormamise funktsiooniga, ehitatakse vajalikud failid ainult siis, kui külastatakse konkreetset marsruuti, võimaldades kohest käivitamist olenemata projekti suurusest.
- Shiki koodihighlighting: vaikimisi integreeritud Shiki, mis täidab süntaksihighlighting'i ehitamise ajal, toetab teema vahetust, transformerite laiendusi, nagu @rspress/plugin-twoslash, pakkudes rikkalikumaid koodiplokkide esituse efekte.
- Dokumentide arendamise kogemus: optimeeritud nav.json, meta.json jne failide HMR ja lisatud json skeem IDE koodinõuannete jaoks; vaikimisi on lubatud katkiste linkide kontrollimise funktsioon; lisatud failide koodiplokkide süntaks, mis toetab väliste failide viitamist; @rspress/plugin-preview ja @rspress/plugin-playground toetavad samaaegset kasutamist jne.
- Rslib integreerimine: nüüd on võimalik luua Rspress dokumentide tööriistana, kui luuakse komponentide raamatukogu projekti create-rslib abil, et kiiresti luua komponentide dokumentatsioonileht.
2.0 uued omadused
Täiesti uus teema
2.0 vaikimisi teema on läbinud süsteemse uuenduse, mille on kujundanud meeskonna disainer @Zovn Wei, pakkudes suurt visuaalset ja lugemiskogemuse paranemist ning iga komponent on eraldi asendatav, omades suurt kohandatavust.
Teema kohandamine
Kohandamise taseme järgi madalast kõrgele on neli kohandamisviisi: CSS muutujad, BEM klassinimed, ESM ümberlaadimine, komponentide eject.- CSS muutujad: Uus teema toob esile rohkem CSS muutujaid, mis katab teema värvid, koodiplokid, avalehe jne stiilid. Sa saad interaktiivselt eelvaadata ja kohandada kõiki CSS muutujaid CSS muutuja lehe kaudu ning leida rahuldava konfiguratsiooni, mille saad otse projekti kasutada.
- BEM klassinimed: Sisseehitatud komponendid kasutavad nüüd BEM nimetamistava. See on väga vanakooli valik, kuid ka meie hoolikalt läbimõeldud otsus. Kasutajad saavad CSS valijate kaudu täpselt stiile kohandada, HTML struktuur on selgem.
- ESM uuesti eksportimine: Kui CSS muudatused ei rahulda kohandamisvajadusi, saab sügavamate kohandamiste jaoks kasutada JS-i. Failis theme/index.tsx kasutades ESM uuesti eksportimist, saab ülekirjutada ükskõik millise Rspressi sisseehitatud komponendi.
- Komponendi eemaldamine: Sa saad kasutada täiesti uut käsku rspress eject [component], mis kopeerib määratud komponendi allika koodi kausta theme/components/. Sa saad neid koode vabalt muuta, isegi anda need AI-le, et saavutada sügavat kohandamist.
Navigeerimisriba, külgriba silt
Rspress 2.0 on rakendanud Silt komponenti, nüüd saab kasutada frontmatteris sildi atribuuti, et teha UI märgistusi külgribal või navigeerimisribale.
Sisseehitatud mitmekeelsus
Versioonis 1.x oli Rspressis ainult ingliskeelne tekst, kui kasutada muid keeli nagu zh, tuli kõik tekstid konfigureerida, mis oli üsna tülikas. Nüüd on 2.0 teemas sisseehitatud tõlked mitmetes keeltes nagu zh, en, ja, ko, ru jne, süsteem teeb automaatselt "Tree Shaking" vastavalt keele konfiguratsioonile, pakkides ainult need tekstid ja keeled, mida sa kasutad.
llms.txt tugi
Rspress on nüüd integreerinud llms.txt genereerimise võimekuse tuumasse ning rakendanud täiesti uue SSG-MD (Static Site Generation to Markdown, staatilise saidi Markdown genereerimine) võimekuse.
Reacti dünaamiliselt renderdatud esiküljel on sageli staatiliste andmete väljavõtmise probleem, Rspress seisab silmitsi sama väljakutsega. Rspress võimaldab kasutajatel MDX fragmentide, React komponentide, Hooks'i ja TSX marsruutide kaudu dünaamilisi omadusi, et suurendada dokumentide väljendusvõimet. Kuid need dünaamilised sisud seisavad Markdown tekstiks konverteerimisel silmitsi järgmiste probleemidega:
- Otse MDX andmine AI-le sisaldab suures koguses koodisüntaksi müra ja kaotab React komponentide sisu.
- HTML-i konverteerimine Markdowniks ei ole sageli efektiivne, teabe kvaliteet on raske tagada.
Selle probleemi lahendamiseks tutvustas Rspress 2.0 SSG-MD omadust. See on täiesti uus funktsioon, mis sarnaneb staatilise saidi genereerimisega (SSG), kuid erinevus seisneb selles, et see renderdab sinu lehe Markdown failideks, mitte HTML failideks, ning genereerib llms.txt ja llms-full.txt seotud failid.
Shiki kompileerimise ajal koodiplokkide esiletõstmineRspress 2.0 vaikimisi kasutab Shiki koodi esiletõstmiseks. Erinevalt 1.x prism'i jooksva esiletõstmise lahendusest, lõpetab Shiki esiletõstmise töötlemise kompileerimise ajal.
- Toetab mitmeid teema stiile, näiteks CSS muutuja lehe kaudu saab interaktiivselt vahetada ja eelvaadata erinevaid Shiki teemasid.
- Samuti võimaldab Shiki kasutada kohandatud transformer'it laiendamiseks, et rikastada kirjutamist, näiteks twoslash jne.
- Programmeerimiskeeli tohib importida vastavalt vajadusele, ilma et see suurendaks jooksva aja kulu ja paketi suurust.
- Põhineb TextMate süntaksil, et saavutada VS Code'iga ühtlane täpne süntaksi esiletõstmine.
Ehitussoorituse paranemine
Rspress 2.0 aluseks on Rsbuild ja Rspack 2.0 eelvaate versioon, samas on vaikimisi sisse lülitatud vajadusel kompileerimine ja püsiv vahemälu.
Vajadusel kompileerimine
Vaikimisi on sisse lülitatud dev.lazyCompilation, ainult siis, kui külastate mingit lehte, kompileeritakse see leht, mis oluliselt kiirendab arenduse käivitamise kiirus, isegi saavutades millisekundite tasemel külma käivituse. Rspress rakendab samuti marsruudi eelkoormuse strateegiat, kui hiirega lingil üle hõljuda, laaditakse sihtmarsruudi leht eelnevalt, koos lazyCompilation'iga saavutatakse kaotusteta arenduskogemus.
Püsiv vahemälu
2.0 on samuti vaikimisi sisse lülitatud püsiv vahemälu, mis taaskasutab eelneva kompileerimise tulemusi kuumkäivituses, suurendades ehituse kiirus 30%-60%. See tähendab, et pärast rspress dev või rspress build esmakordset käivitamist, on edasised käivitamise kiirus oluliselt paranenud.
Dokumentide arenduskogemus
Vaikimisi sisse lülitatud katkiste linkide kontroll
Rspress 2.0 vaikimisi aktiveerib katkiste linkide kontrollimise funktsiooni. Ehitusprotsessi käigus tuvastatakse automaatselt dokumentides kehtetud lingid, aidates teil neid õigeaegselt avastada ja parandada.
Faili koodiplokid
Saate kasutada file="./path/to/file" atribuuti, et viidata välistele failidele koodiploki sisuna, hoides näidiskoodi eraldi failis.
preview paindlikum meta kasutamine
@rspress/plugin-preview põhineb nüüd meta atribuudil, olles paindlikum ja seda saab kasutada koos failikoodiplokkidega.
Rslib & Rspress
Kui kasutate create-rslib projekti loomisel, saate nüüd valida Rspress tööriista. See võimaldab teil arendada komponente samal ajal, kui kiiresti luua vastavad dokumentide saidid, et kirjutada komponentide kasutusjuhiseid, näidata API viiteid või reaalajas eelvaateid komponentide efektidest.
Rohkem Rspress ametlikke pluginaid
Rspress 2.0 on lisanud mitmeid ametlikke pluginaid:
- @rspress/plugin-algolia: toetab Rspress'i sisseehitatud otsingu asendamist Algolia DocSearch'iga
- @rspress/plugin-twoslash: lisab TypeScript koodiplokkidele tüübi vihjeid
- @rspress/plugin-llms: pakub llms.txt genereerimise võimalust projektidele, mis ei toeta SSG ja SSG-MD
- @rspress/plugin-sitemap: genereerib automaatselt Sitemap faili SEO optimeerimiseks
Murdmis muudatused
Rspress 1.x üleminek
Kui olete 1.x projekti kasutaja, oleme koostanud põhjaliku ülemineku dokumendi, et aidata teil 1.x versioonist 2.0 versioonile üle minna. Saate otse kasutada lehe "Kopeeri Markdown" funktsiooni, et sisestada see oma lemmik koodimisagendile (nt Claude Code jne), et üleminek lõpule viia.### Node.js ja ülemiste sõltuvuste versiooninõuded
Rspress 2.0 nõuab Node.js versiooni 20+ ja React versiooni 18+.
Järgmised sammud
Rspress 2.0 väljaanne on vaid uus algus. Pärast seda väljaannet jätkab Rspress pidevat iteratsiooni:
- Ökosüsteemi integreerimise edendamine: sügavam koostöö Rslib ja Rstestiga, et pakkuda front-end projektide ja komponentide raamatukogude projektide integreeritud arenduskogemust.
- AI ja dokumentide sügavam integreerimine: nagu nutikas küsimuste ja vastuste süsteem, automaatne kokkuvõte jne; täiustada SSG-MD, et muuta see stabiilsemaks ja kasutajasõbralikumaks.
npm create rspress@latest
