Rspress 2.0 objavljen: potpuno novo unapređenje usmereno na iskustvo i AI

Sa zadovoljstvom najavljujemo zvanično izdanje Rspress 2.0!

Rspress je statički generator sajtova zasnovan na Rsbuild, alat za dokumentaciju dizajniran posebno za programere. Od zvaničnog izdanja 2023. godine, Rspress 1.x je imao 144 verzije i 125 saradnika koji su učestvovali u razvoju projekta. Sve više programera bira Rspress, koristeći njegove efikasne performanse kompajliranja, konvencionalno usmeravanje i pregled biblioteke komponenti za izgradnju lepih i pouzdanih sajtova za dokumentaciju.

Na osnovu povratnih informacija i sugestija zajednice, Rspress 2.0 je napredovao u oblastima estetike tema, AI-native, iskustva razvoja dokumentacije, korišćenja sa Rslib i drugim aspektima.

Zašto Rspress 2.0

Rspress 1.x je već rešio problem performansi kompajliranja okvira za sajtove sa dokumentacijom, ali još uvek postoje neki problemi koji utiču na osnovno iskustvo kao alata za razvoj dokumentacije. Verzija 2.0 se ne fokusira samo na poboljšanje performansi kompajliranja, već se takođe usredsređuje na druge aspekte iskustva sajtova za dokumentaciju:

• Stil teme: set lepših podrazumevanih tema, uz više načina za prilagođavanje tema, rešava problem nedostatka stabilnog API-ja za prilagođavanje tema u 1.x.
• AI-native: dokumenti ne samo da služe ljudskim čitaocima, već ih i Agent treba bolje razumeti i koristiti. Rspress sada ima ugrađenu funkcionalnost za generisanje llms.txt i SSG-MD izvedenih iz SSG, generišući visokokvalitetan Markdown sadržaj za čitanje od strane Agenta.
• Kompajliranje na zahtev, trenutni start: podrazumevano omogućava lazyCompilation, u kombinaciji sa funkcijom preload resursa prilikom hover-a na linkove, gradi potrebne datoteke samo kada se pristupa određenim rutama, omogućavajući trenutni start bez obzira na veličinu projekta.
• Shiki isticanje koda: podrazumevano integrisano Shiki, završava isticanje sintakse tokom gradnje, podržava promenu tema, ekstenzije transformatora, kao što je @rspress/plugin-twoslash, donoseći bogatije efekte prikaza blokova koda.
• Iskustvo razvoja dokumentacije: optimizuje HMR za nav.json, meta.json i druge datoteke i dodaje json shemu za kodne savete unutar IDE-a; podrazumevano omogućava proveru mrtvih linkova; dodaje sintaksu za blokove koda, podržava referenciranje spoljašnjih datoteka; @rspress/plugin-preview i @rspress/plugin-playground podržavaju istovremenu upotrebu itd.
• Integracija Rslib: sada možete izabrati Rspress kao alat za dokumentaciju prilikom korišćenja create-rslib za kreiranje projekata biblioteka komponenti, brzo postavljajući sajt za dokumentaciju komponenti.

2.0 nove karakteristike

Potpuno nova tema

Podrazumevana tema 2.0 je doživela sistemsko unapređenje, koju je celokupno dizajnirao tim dizajnera @Zovn Wei, sa značajnim poboljšanjima u vizuelnom efektu i iskustvu čitanja, a svaki komponent može se nezavisno zameniti, pružajući visoku prilagodljivost.

Prilagođavanje teme

Prema stepenu prilagođavanja, postoje četiri načina za prilagođavanje tema: CSS promenljive, BEM imena klasa, ESM ponovna izvoz pokriva, komponenta eject.- CSS varijable: Nova tema izlaže više CSS varijabli, pokrivajući stilove za temu boje, blokove koda, početnu stranicu itd. Možete interaktivno pregledati i prilagoditi sve CSS varijable na stranici CSS varijabli, a nakon što pronađete zadovoljavajuću konfiguraciju, jednostavno je kopirajte za korišćenje u projektu.

• BEM imena klasa: Ugrađeni komponenti sada koriste BEM nomenklaturu. Ovo je veoma Old School izbor, ali je takođe naš promišljen izbor. Korisnici mogu precizno prilagoditi stilove putem CSS selektora, a HTML struktura je jasnija.
• ESM ponovo izvoz pokriva: Ako izmene na CSS-u ne zadovoljavaju prilagođene potrebe, možete izvršiti dublje prilagođavanje putem JS-a. U theme/index.tsx koristeći ESM ponovo izvoz, možete pokriti bilo koju ugrađenu komponentu Rspress-a.
• Eject komponenta: Možete koristiti potpuno novu rspress eject [component] komandu, koja će kopirati izvorni kod određene komponente u theme/components/ direktorijum, a vi možete slobodno menjati taj kod, čak i direktno ga predati AI-u na izmene, kako biste postigli duboku prilagodbu.

Navigaciona traka, bočna traka tag

Rspress 2.0 implementira Tag komponentu, sada možete koristiti tag atribut u frontmatter-u za UI označavanje u bočnoj ili navigacionoj traci.

Ugrađena podrška za više jezika

U verziji 1.x, Rspress je imao samo ugrađeni engleski tekst, a ako koristite druge jezike kao što je zh, morali ste da konfigurišete sav tekst, što je bilo prilično nezgodno. Sada 2.0 tema ima ugrađene prevode za više jezika kao što su zh, en, ja, ko, ru itd., a sistem će automatski izvršiti "Tree Shaking" na osnovu jezičke konfiguracije, pakujući samo tekst i jezike koje koristite.

llms.txt podrška

Rspress sada integriše mogućnost generisanja llms.txt u core, i implementira novu SSG-MD (Static Site Generation to Markdown, generisanje statičkog sajta u Markdown) sposobnost.

U front-end okvirima zasnovanim na React-u, često postoji problem sa teškoćom ekstrakcije statičnih informacija, a Rspress se suočava sa istim izazovima. Rspress omogućava korisnicima da poboljšaju izražajnost dokumenata putem MDX fragmenata, React komponenti, Hooks-a i TSX ruta. Međutim, ovi dinamični sadržaji se suočavaju sa sledećim problemima prilikom konverzije u Markdown tekst:

• Direktno davanje MDX-a AI-u će sadržati mnogo sintaktičkog šuma i izgubiti sadržaj React komponenti
• Pretvaranje HTML-a u Markdown često daje loše rezultate, a kvalitet informacija je teško garantovati

Da bi se rešio ovaj problem, Rspress 2.0 uvodi SSG-MD karakteristiku. Ovo je potpuno nova funkcija, slična statičkom generisanju sajta (SSG), ali se razlikuje po tome što vašu stranicu renderuje kao Markdown datoteku, umesto HTML datoteke, i generiše llms.txt i llms-full.txt povezane datoteke.

Shiki kompajliranje za isticanje kod blokovaRspress 2.0 подразумева по подразумеваној употреби Shiki за истакнуто кодирање. У поређењу са 1.x prism решењем за истакнуто кодирање у време извршавања, Shiki завршава обраду истакнутог кодирања у време компилације.

• Подржава више стилова тема, на пример, на страници CSS променљивих можете интерактивно прелазити и прегледати различите Shiki теме.
• Такође, Shiki омогућава коришћење прилагођених трансформатора за обогаћивање писања, као што је twoslash и други.
• Уводите програмске језике по потреби, без повећања трошкова у време извршавања и величине пакета.
• Засновано на TextMate синтакси, пружа тачно истакнуто кодирање у складу са VS Code.

Повећање перформанси изградње

Rspress 2.0 је покренут од стране Rsbuild и Rspack 2.0 прегледне верзије, а подразумевано је укључено компилација по потреби и перзистентно кеширање.

Компилација по потреби

Подразумевано је укључена dev.lazyCompilation, само када приступите некој страници, та страница ће бити компилирана, што значајно повећава брзину покретања развоја, чак и омогућава хладан старт у милисекундама. Rspress такође реализује стратегију предучитања рута, када курсор буде изнад линка, предучитаће циљну руту, у комбинацији са lazyCompilation за безгубно искуство развоја.

Перзистентно кеширање

2.0 такође подразумевано укључује перзистентно кеширање, поново користећи резултате последње компилације у топлом старту, повећавајући брзину изградње за 30%-60%. То значи да ће након првог покретања rspress dev или rspress build, накнадна брзина покретања бити значајно побољшана.

Искусство развоја документације

Подразумевано укључена провера мртвих линкова

Rspress 2.0 подразумевано укључује функцију провере мртвих линкова. Током изградње, аутоматски ће проверити неважеће линкове у документу, помажући вам да их благовремено откријете и исправите.

Кодни блокови датотека

Можете користити атрибут file="./path/to/file" да позовете спољне датотеке као садржај кодног блока, одржавајући пример код у одвојеним датотекама.

preview флексибилнија meta употреба

@rspress/plugin-preview сада користи meta атрибут, што је флексибилније и може се комбиновати са кодним блоковима датотека.

Rslib & Rspress

Када користите create-rslib за креирање пројекта, сада можете изабрати Rspress алат. Ово вам омогућава да брзо изградите пратећу документацију док развијате библиотеку компоненти, за писање упутстава за употребу компоненти, приказивање API референци или реално прегледање ефеката компоненти.

Више званичних Rspress плугина

Rspress 2.0 је додао више званичних плугина:

• @rspress/plugin-algolia: подржава замену Rspress-ове уграђене претраге са Algolia DocSearch
• @rspress/plugin-twoslash: додаје типске наводе за TypeScript кодне блокове
• @rspress/plugin-llms: пружа могућност генерисања llms.txt за пројекте који не подржавају SSG и SSG-MD
• @rspress/plugin-sitemap: аутоматски генерише Sitemap датотеке за оптимизацију SEO

Промене које нарушавају компатибилност

Миграција са Rspress 1.x

Ако сте корисник 1.x пројекта, припремили смо детаљну документацију о миграцији, која вам помаже да надоградите са 1.x на 2.0. Можете директно користити функцију "Копирај Markdown" на страници, да бисте је унели у ваш уобичајени кодни агент (као што је Claude Code и други) да бисте завршили миграцију.### Node.js i zahtevi verzije zavisnosti

Rspress 2.0 zahteva Node.js verziju 20+, React verziju 18+.

Sledeći koraci

Objavljivanje Rspress 2.0 je samo nova tačka početka. Nakon ovog izdanja, Rspress će nastaviti da se iterira:

• Napredovanje ekološke integracije: dublja integracija sa Rslib, Rstest, pružajući integrisano iskustvo razvoja za frontend projekte i projekte biblioteka komponenti.
• Istraživanje dublje integracije AI i dokumentacije: kao što su pametni odgovori, automatski sažeci itd.; unapređenje SSG-MD kako bi postao stabilniji i lakši za korišćenje.

Odmah koristite ili nadogradite na Rspress 2.0, doživite novo putovanje u razvoju dokumentacije!

npm create rspress@latest