Documentația Zettlr primește un upgrade major cu VuePress
Documentația este una dintre cele mai importante componente ale oricărui software. Fără explicații clare și ușor de urmărit, utilizatorii — fie ei începători sau avansați — ajung să se lovească de limite, neînțelegeri și funcționalități folosite greșit. Echipa Zettlr a recunoscut această realitate și a decis să ofere documentației o actualizare majoră, una care să reflecte standardele moderne de accesibilitate, viteză și organizare.
De ce era nevoie de o schimbare
Documentația Zettlr a fost construită timp de un deceniu pe MkDocs, un framework solid, dar care și-a arătat vârsta în ultimii ani. Designul Material, considerat modern acum zece ani, este perceput astăzi ca fiind depășit . În plus, echipa a fost nevoită să adauge numeroase patch-uri pentru a compensa lipsurile framework-ului vechi. A trebuit să oferim multe patch-uri și remedieri pentru a adăuga funcționalități pe care le-am considerat necesare pentr….
După luni de analiză și testare, MkDocs a fost înlocuit cu VuePress, un framework modern, activ întreținut și mult mai flexibil .
VuePress: un motor modern pentru documentație
VuePress oferă o structură mai lizibilă, un layout mai aerisit și viteze de încărcare semnificativ îmbunătățite . Documentația rămâne statică și păstrează aceleași URL-uri, astfel încât toate marcajele și linkurile existente continuă să funcționeze fără probleme. De asemenea, fiecare URL a rămas la fel, așa că orice marcaje și linkuri pe care le mai ai vor funcționa în continuare..
Pentru contribuitori, layout-ul repository-ului este neschimbat, ceea ce face tranziția complet transparentă .
Documentație multilingvă, fără compromisuri
Una dintre cele mai mari îmbunătățiri este suportul nativ pentru internaționalizare (i18n) . În trecut, echipa era nevoită să „falsifice” multilingvismul prin pagini duplicate, greu de întreținut. MkDocs nu a suportat niciodată pagini de documentație multilingve, așa că a trebuit să „falsificăm” această funcție cons….
Acum, utilizatorii pot schimba limba direct din selectorul de limbă, iar dacă pagina există în traducerea comunitară, sunt direcționați automat către versiunea corectă .
Eliminarea paginilor duplicate și învechite face ca sidebar-ul să reflecte fidel progresul traducerilor, motivând comunitatea să contribuie mai activ la actualizarea lor .
Experiență mobilă și accesibilitate îmbunătățite
Documentația veche folosea un layout fix, dificil de navigat pe telefoane și tablete . VuePress rezolvă această problemă printr-un design fluid, care se adaptează automat la orice dimensiune de ecran. Pagina se adaptează acum fluent la ecranul pe care îl privești — monitoare desktop mari, laptopuri, tablete sau telefoan….
În plus, framework-ul oferă:
- mod întunecat nativ, ideal pentru citit pe timp de noapte
- navigare îmbunătățită pentru cititoare de ecran, crescând accesibilitatea pentru toți utilizatorii
Căutare mai rapidă și mai intuitivă
Căutarea integrată în bara de meniu este mai rapidă, mai precisă și mai ușor de utilizat decât sistemul vechi, care necesita încărcarea unei pagini dedicate de rezultate . Acum, utilizatorii beneficiază de scurtături de tastatură și navigare instantă către paginile relevante. Acum vine cu scurtături de tastatură peste tot, o prezentare generală mai ușoară și o navigare mai rapidă către toate pa….
Noi modalități de vizualizare a conținutului
VuePress aduce suport extins pentru Markdown modern:
- admonitions variate pentru note, avertizări și sfaturi
- buton de copy pentru blocurile de cod
- suport pentru matematică și randare îmbunătățită a imaginilor
- previzualizări live ale sintaxei Markdown, cu sursa vizibilă la click
- vizualizări de structuri de foldere pentru secțiunile conceptuale
Aceste funcționalități fac documentația mai clară, mai vizuală și mai ușor de urmărit.
Extensibilitate și viitor
Pentru echipa Zettlr, VuePress este o alegere naturală: framework-ul este construit pe Vue, aceeași tehnologie care stă la baza interfeței aplicației Zettlr . Această compatibilitate permite extinderea documentației cu noi componente și funcționalități într-un mod rapid și eficient.
Un apel către comunitate
Pe lângă migrarea tehnică, echipa a revizuit întreaga documentație pentru a elimina informațiile învechite și a clarifica explicațiile complexe . Multe traduceri comunitare sunt incomplete sau neactualizate, iar contribuțiile utilizatorilor sunt esențiale pentru a face documentația accesibilă unui public global.
Concluzie
Noua documentație Zettlr reprezintă un pas important spre claritate, accesibilitate și modernizare. Cu un framework puternic, suport multilingv nativ și o experiență de navigare mult îmbunătățită, utilizatorii pot în sfârșit explora funcționalitățile aplicației într-un mod intuitiv și eficient.
