Rspress 2.0 izlaidums: jauna uzlabojuma pieredze un AI virzienā

Mēs ar prieku paziņojam par Rspress 2.0 oficiālo izlaidumu!

Rspress ir statisku vietņu ģenerators, kas balstīts uz Rsbuild, un tas ir izstrādāts kā dokumentācijas rīks izstrādātājiem. Kopš 2023. gada oficiālā izlaiduma Rspress 1.x ir veicis 144 versiju iterācijas, un projektā ir piedalījušies 125 līdzautori. Aizvien vairāk izstrādātāju izvēlas Rspress, izmantojot tā efektīvo kompilācijas veiktspēju, konvencionālo maršrutēšanu un komponentu bibliotēkas priekšskatījumu, lai izveidotu pievilcīgas un uzticamas dokumentācijas vietnes.

Balstoties uz kopienas atsauksmēm un ieteikumiem, Rspress 2.0 ir vēl vairāk uzlabots tematu estētikā, AI-native, dokumentācijas izstrādes pieredzē, izmantojot kopā ar Rslib u.c.

Kāpēc Rspress 2.0

Rspress 1.x jau ir atrisinājis dokumentācijas vietņu ietvara kompilācijas veiktspējas problēmas, taču joprojām pastāv dažas problēmas, kas ietekmē kā dokumentācijas izstrādes rīka pamatpieredzi. 2.0 versija neaprobežojas tikai ar kompilācijas veiktspējas uzlabošanu, bet arī koncentrējas uz citiem dokumentācijas vietņu pieredzes aspektiem:

• Tematu stils: jauna estētiskāka noklusējuma tēma, kā arī dažādas pielāgošanas iespējas, kas atrisina 1.x problēmu ar stabilu API trūkumu tēmu pielāgošanā.
• AI-native: dokumentācija ne tikai kalpo cilvēku lasītājiem, bet arī ir jābūt labāk saprotamai un izmantojamai aģentiem. Rspress tagad iekļauj llms.txt ģenerēšanu un no SSG atvasinātu SSG-MD funkcionalitāti, lai ģenerētu augstas kvalitātes Markdown renderēšanas saturu aģentu lasīšanai.
• Kompilācija pēc pieprasījuma, tūlītēja palaišana: noklusējuma iestatījumos ir iespējota lazyCompilation, kas kopā ar resursu preload funkciju, kad tiek pārvietots uz saitēm, būvē nepieciešamos failus tikai tad, kad tiek apmeklēti konkrēti maršruti, nodrošinot, ka neatkarīgi no projekta apjoma, dev var tūlīt palaist.
• Shiki koda izcelšana: noklusējuma integrācija ar Shiki, kas veic sintakses izcelšanu būvniecības laikā, atbalsta tēmu maiņu, transformeru paplašinājumus, piemēram, @rspress/plugin-twoslash, nodrošinot bagātīgāku koda bloku attēlošanas efektu.
• Dokumentācijas izstrādes pieredze: optimizēti nav.json, meta.json u.c. failu HMR un pievienots json shēmas atbalsts IDE koda ieteikumiem; noklusējuma iestatījumos ir iespējota mirušo saišu pārbaude; pievienota failu koda bloku sintakse, kas atbalsta ārējo failu atsauces; @rspress/plugin-preview un @rspress/plugin-playground atbalsta vienlaicīgu izmantošanu u.c.
• Rslib integrācija: tagad, izmantojot create-rslib, izveidojot komponentu bibliotēkas projektu, var izvēlēties Rspress kā dokumentācijas rīku, lai ātri izveidotu komponentu dokumentācijas vietni.

2.0 jaunas iezīmes

Pilnīgi jauna tēma

2.0 noklusējuma tēma ir piedzīvojusi sistemātisku uzlabojumu, ko izstrādājusi komandas dizainere @Zovn Wei, un tā ir ievērojami uzlabojusi vizuālo efektu un lasīšanas pieredzi, kā arī katrs komponents var tikt neatkarīgi aizvietots, nodrošinot augstu pielāgojamību.

Tēmas pielāgošana

Pielāgošanas pakāpes secībā no zemākas uz augstāku ir četras tēmas pielāgošanas iespējas: CSS mainīgie, BEM klasifikatori, ESM atkārtota eksportēšana, komponentu izsistīšana.- CSS mainīgās: Jaunā tēma atklāj vairāk CSS mainīgo, kas pārklāj tēmas krāsas, koda blokos, sākumlapas u.c. stilus. Tu vari interaktīvi apskatīt un pielāgot visus CSS mainīgos CSS mainīgo lapā, un, kad esi atradis apmierinošu konfigurāciju, to var tieši kopēt projektā.

• BEM klases nosaukumi: Iebūvētie komponenti tagad izmanto BEM nosaukšanas standartu. Tas ir diezgan vecmodīgs izvēle, bet arī mūsu rūpīgi pārdomāts lēmums. Lietotāji var precīzi pielāgot stilus, izmantojot CSS selektorus, un HTML struktūra kļūst skaidrāka.
• ESM atkārtota eksportēšana: Ja CSS izmaiņas nevar apmierināt pielāgošanas vajadzības, var veikt dziļāku pielāgošanu, izmantojot JS. Izmantojot ESM atkārtotu eksportēšanu theme/index.tsx, var pārklāt jebkuru no Rspress iebūvētajiem komponentiem.
• Komponenta izsistīšana: Tu vari izmantot jauno rspress eject [component] komandu, kas kopēs norādītā komponenta avota kodu uz theme/components/ direktoriju, ļaujot brīvi modificēt šo kodu, pat nodot to AI modificēšanai, lai veiktu dziļu pielāgošanu.

Navigācijas josla, sānu josla tag

Rspress 2.0 ir īstenojis Tag komponentu, tagad var izmantot frontmatter tag īpašību, lai veiktu UI marķēšanu sānu joslā vai navigācijas joslā.

Iebūvēta daudzvalodu atbalsts

1.x versijā Rspress iekļāva tikai angļu valodas tekstu, ja tika izmantota cita valoda, piemēram, zh, bija nepieciešams konfigurēt visus tekstus, kas bija diezgan apgrūtinoši. Tagad 2.0 tēma iekļauj tulkojumus vairākām valodām, piemēram, zh, en, ja, ko, ru utt., un sistēma automātiski veiks "Tree Shaking" atkarībā no valodas konfigurācijas, tikai iepakojot tekstus un valodas, kuras tu izmanto.

llms.txt atbalsts

Rspress tagad ir integrējis llms.txt ģenerēšanas spējas kodolā un īstenojis jaunu SSG-MD (Static Site Generation to Markdown, statiskā vietne Markdown ģenerēšana) spēju.

Pamatojoties uz React dinamisko renderēšanu, bieži vien ir grūti izvilkt statisko informāciju, un Rspress saskaras ar līdzīgām problēmām. Rspress ļauj lietotājiem uzlabot dokumentu izteiksmīgumu, izmantojot MDX fragmentus, React komponentus, Hooks un TSX maršrutus. Bet šie dinamiskie saturs, pārvēršot to par Markdown tekstu, saskaras ar šādām problēmām:

• Tieši ievadot MDX AI, tiks iekļauta liela daudzuma koda sintakses troksnis un tiks zaudēts React komponentu saturs.
• HTML pārvēršana par Markdown bieži vien nav efektīva, un informācijas kvalitāte ir grūti garantējama.

Lai atrisinātu šo problēmu, Rspress 2.0 ievieš SSG-MD funkciju. Tas ir jauns rīks, kas līdzīgs statiskās vietnes ģenerēšanai (SSG), bet atšķirība ir tāda, ka tas renderē tavu lapu kā Markdown failu, nevis HTML failu, un ģenerē llms.txt un llms-full.txt saistītos failus.

Shiki kompilācijas laikā koda bloku izcelšanaRspress 2.0 noklusējuma izmanto Shiki, lai veiktu koda izcelšanu. Salīdzinājumā ar 1.x prism izpildlaika izcelšanas risinājumu, Shiki veic izcelšanu kompilācijas laikā.

• Atbalsta dažādus tēmu stilus, piemēram, CSS mainīgo lapā var interaktīvi pārslēgt un priekšskatīt dažādas Shiki tēmas.
• Tajā pašā laikā Shiki arī ļauj izmantot pielāgotus transformatorus, lai bagātinātu rakstīšanu, piemēram, twoslash utt.
• Ievieš programmēšanas valodas pēc pieprasījuma, nepalielinot izpildlaika slodzi un pakotnes izmēru.
• Balstīts uz TextMate sintaksi, nodrošina precīzu sintakses izcelšanu, kas ir saskaņota ar VS Code.

Veiktspējas uzlabošana

Rspress 2.0 pamatā ir Rsbuild un Rspack 2.0 priekšskatījuma versija, un tajā ir noklusējuma iestatīta kompilācija pēc pieprasījuma un pastāvīga kešatmiņa.

Kompilācija pēc pieprasījuma

Noklusējuma iestatījums dev.lazyCompilation ir ieslēgts, un tikai tad, kad tu apmeklē kādu lapu, šī lapa tiks kompilēta, būtiski uzlabojot izstrādes palaišanas ātrumu, pat sasniedzot milisekundes aukstā palaišana. Rspress arī īsteno maršrutu iepriekšējās ielādes stratēģiju, kad pele ir virs saites, tā iepriekš ielādē mērķa maršruta lapu, apvienojot lazyCompilation, lai nodrošinātu bezzaudējumu izstrādes pieredzi.

Pastāvīga kešatmiņa

2.0 noklusējuma iestatījums ir ieslēgta pastāvīga kešatmiņa, kas karstajā palaišanā atkārtoti izmanto iepriekšējās kompilācijas rezultātus, uzlabojot būvēšanas ātrumu par 30%-60%. Tas nozīmē, ka pēc pirmās rspress dev vai rspress build palaišanas, turpmākā palaišanas ātrums būs ievērojami uzlabots.

Dokumentu izstrādes pieredze

Noklusējuma ieslēgta mirušo saišu pārbaude

Rspress 2.0 noklusējuma iestatījums ir ieslēgta mirušo saišu pārbaude. Būvēšanas procesā automātiski tiek pārbaudītas dokumentā esošās nederīgās saites, palīdzot tev laikus atklāt un labot.

Failu koda bloki

Tu vari izmantot file="./path/to/file" atribūtu, lai atsauktos uz ārējiem failiem kā koda bloku saturu, saglabājot piemēru kodu atsevišķā failā.

preview elastīgāka meta lietošana

@rspress/plugin-preview tagad balstās uz meta atribūtu, kas ir elastīgāks, un to var izmantot kopā ar failu koda blokiem.

Rslib & Rspress

Izmantojot create-rslib, lai izveidotu projektu, tagad vari izvēlēties Rspress rīku. Tas ļauj tev izstrādāt komponentu bibliotēku, vienlaikus ātri izveidojot atbilstošu dokumentācijas vietni, lai rakstītu komponentu lietošanas instrukcijas, demonstrētu API atsauces vai reāllaikā priekšskatītu komponentu efektus.

Vairāk Rspress oficiālo spraudņu

Rspress 2.0 ir pievienoti vairāki oficiālie spraudņi:

• @rspress/plugin-algolia: atbalsta Rspress iebūvētā meklēšanas aizvietošanu ar Algolia DocSearch
• @rspress/plugin-twoslash: pievieno tipu norādes TypeScript koda blokiem
• @rspress/plugin-llms: nodrošina llms.txt ģenerēšanas iespēju projektiem, kas neatbalsta SSG un SSG-MD
• @rspress/plugin-sitemap: automātiski ģenerē Sitemap failus, lai optimizētu SEO

Lūzuma izmaiņas

Migrācija no Rspress 1.x

Ja tu esi 1.x projekta lietotājs, mēs esam sagatavojuši detalizētu migrācijas dokumentāciju, lai palīdzētu tev jaunināt no 1.x uz 2.0. Tu vari tieši izmantot lapā esošo "Kopēt Markdown" funkciju, lai to ievadītu savā bieži izmantotajā kodēšanas aģentā (piemēram, Claude Code utt.), lai pabeigtu migrāciju.Rspress 2.0 prasa Node.js versiju 20+, React versiju 18+.\n\n## Nākamie soļi\n\nRspress 2.0 izlaišana ir tikai jauns sākums. Pēc šīs izlaišanas Rspress turpinās iterāciju:\n\n- Veicināt ekosistēmas integrāciju: dziļāka integrācija ar Rslib, Rstest, nodrošinot integrētu izstrādes pieredzi priekšējā projekta un komponentu bibliotēku projektam.\n- Izpētīt AI un dokumentu dziļāku integrāciju: piemēram, inteliģenta jautājumu un atbilžu sistēma, automātiskā kopsavilkuma u.c.; uzlabot SSG-MD, lai tas būtu stabilāks un vieglāk lietojams.\n\nSāciet izmantot vai atjauniniet uz Rspress 2.0, lai piedzīvotu jaunu dokumentu izstrādes ceļojumu!\n\nnpm create rspress@latest