Rspress 2.0 publicat: una nova actualització centrada en l'experiència i la IA
Rspress 2.0 publicat: una nova actualització centrada en l'experiència i la IA
Estem molt contents d'anunciar la publicació oficial de Rspress 2.0!
Rspress és un generador de llocs estàtics basat en Rsbuild, dissenyat com una eina de documentació per a desenvolupadors. Des de la seva publicació oficial el 2023, Rspress 1.x ha acumulat 144 versions i 125 col·laboradors han participat en el desenvolupament del projecte. Cada vegada més desenvolupadors escullen Rspress, aprofitant les seves alt rendiment de compilació, rutes per convenció i vista prèvia de la biblioteca de components, per construir llocs de documentació atractius i fiables.
Basat en els comentaris i suggeriments de la comunitat, Rspress 2.0 ha avançat en aspectes com l'estètica del tema, natiu d'IA, l'experiència de desenvolupament de documentació, i l'ús conjunt amb Rslib.
Per què Rspress 2.0
Rspress 1.x ja havia resolt els problemes de rendiment de compilació del marc de llocs de documentació, però encara hi havia alguns problemes que afectaven l'experiència central com a eina de desenvolupament de documentació. La versió 2.0 no només busca millorar el rendiment de compilació, sinó que també se centra en altres aspectes de l'experiència del lloc de documentació:
- Estil del tema: un nou tema per defecte més atractiu, amb diverses maneres de personalitzar el tema, resolent el problema de la falta d'API estable per a la personalització de temes en 1.x.
- Natiu d'IA: la documentació no només ha de servir als lectors humans, sinó que també necessita ser millor entesa i utilitzada per Agents. Rspress ara inclou la generació de llms.txt i la funcionalitat SSG-MD derivada de SSG, generant contingut de Markdown d'alta qualitat per a la lectura dels Agents.
- Compilació a demanda, inici instantani: habilitat per defecte lazyCompilation, juntament amb la funcionalitat de preload de recursos quan es passa el cursor sobre els enllaços, només construeix els fitxers necessaris quan s'accedeix a rutes específiques, permetent que, independentment de l'escala del projecte, el dev pugui iniciar-se instantàniament.
- Destacat de codi Shiki: integrat per defecte Shiki, completant el destacat de sintaxi durant la construcció, suportant el canvi de tema, extensions de transformador, com @rspress/plugin-twoslash, aportant un efecte de visualització de blocs de codi més ric.
- Experiència de desenvolupament de documentació: optimització de HMR per a fitxers com nav.json, meta.json, i nova json schema per a suggeriments de codi dins de l'IDE; habilitació per defecte de la funcionalitat de comprovació de vincles trencats; nova sintaxi de blocs de codi de fitxers, suportant la referència a fitxers externs; @rspress/plugin-preview i @rspress/plugin-playground suporten l'ús simultani, etc.
- Integració de Rslib: ara es pot triar Rspress com a eina de documentació quan es crea un projecte de biblioteca de components amb create-rslib, construint ràpidament un lloc de documentació de components.
Novetats de 2.0
Nou tema
El tema per defecte de 2.0 ha rebut una actualització sistemàtica, dissenyat pel dissenyador de l'equip @Zovn Wei, amb millores significatives en l'efecte visual i l'experiència de lectura, i cada component es pot substituir de manera independent, oferint una gran personalització.
Personalització del tema
Segons el grau de personalització de més baix a més alt, hi ha quatre maneres de personalitzar el tema: variables CSS, noms de classe BEM, reexportació ESM, i eject de components.- Variables CSS: El nou tema exposa més variables CSS, que cobreixen els colors del tema, blocs de codi, estils de la pàgina d'inici, etc. Pots previsualitzar i ajustar totes les variables CSS de manera interactiva a la pàgina de variables CSS, i després copiar-les directament al teu projecte un cop trobis la configuració que t'agrada.
- Noms de classe BEM: Els components integrats ara utilitzen la norma de nomenclatura BEM. Aquesta és una elecció molt Old School, però també és una decisió ben pensada. Els usuaris poden ajustar els estils amb precisió mitjançant selectors CSS, i l'estructura HTML és més clara.
- Reexportació ESM: Si les modificacions a CSS no satisfan les necessitats de personalització, es pot fer una personalització més profunda mitjançant JS. A theme/index.tsx, mitjançant la reexportació ESM, es pot sobrescriure qualsevol component integrat de Rspress.
- Eject de components: Pots utilitzar la nova comanda rspress eject [component], que copiarà el codi font del component especificat al directori theme/components/, on podràs modificar lliurement aquest codi, fins i tot deixar que AI el modifiqui per aconseguir una personalització profunda.
Etiquetes de la barra de navegació i barra lateral
Rspress 2.0 ha implementat el component Tag, ara es pot utilitzar l'atribut tag a frontmatter per fer anotacions UI a la barra lateral o a la barra de navegació.
Suport multilingüe integrat
A la versió 1.x, Rspress només tenia text en anglès integrat, si s'utilitzaven altres idiomes com el zh, calia configurar tot el text, cosa que era força complicada. Ara, el tema 2.0 inclou textos de traducció en diversos idiomes com zh, en, ja, ko, ru, etc., i el sistema realitzarà automàticament "Tree Shaking" segons la configuració d'idioma, empaquetant només el text i l'idioma que utilitzes.
Suport llms.txt
Rspress ara integra la capacitat de generar llms.txt al nucli, i ha implementat una nova capacitat SSG-MD (Generació de llocs estàtics a Markdown).
En els marcs de front-end basats en React, sovint hi ha problemes per extreure informació estàtica, i Rspress s'enfronta al mateix repte. Rspress permet als usuaris millorar l'expressivitat dels documents mitjançant fragments MDX, components React, Hooks i rutes TSX, entre altres característiques dinàmiques. Però aquest contingut dinàmic es troba amb els següents problemes quan es converteix en text Markdown:
- Donar directament l'entrada MDX a AI inclourà molt soroll de sintaxi de codi i es perdrà el contingut dels components React.
- Convertir HTML a Markdown sovint no dóna bons resultats, i la qualitat de la informació és difícil de garantir.
Per resoldre aquest problema, Rspress 2.0 introdueix la característica SSG-MD. Aquesta és una funció totalment nova, similar a la generació de llocs estàtics (SSG), però la diferència és que renderitza les teves pàgines com a fitxers Markdown, en lloc de fitxers HTML, i genera fitxers relacionats llms.txt i llms-full.txt.
