Perché esiste
Forniamo un'applicazione incentrata sulla documentazione che dimostra come i contenuti gestiti da un CMS possano essere trasformati in un sito di documentazione rifinito senza ricostruire il livello di rendering.
Quando utilizzarla
- ospitare la documentazione di prodotto su contenuti gestiti da un CMS
- rendere documenti fortemente basati su Markdown
- costruire una navigazione della documentazione basata su barra laterale e ricerca
Cosa include
- applicazione Next.js del modello di documentazione
- rendering di route catch-all basate su CMS
- boundary Markdown per la documentazione
- componenti di navigazione, barra laterale e contenuto specifici per la documentazione
- caricamento di articoli e categorie con consapevolezza della lingua
Flusso di lavoro principale
- Configurare l'app di documentazione con le variabili di ambiente del CMS.
- Renderizzare le route della documentazione tramite
cms-renderer. - Recuperare documenti di categorie e articoli dagli schemi del CMS.
- Renderizzare il contenuto Markdown con componenti specifici per la documentazione.
- Sovrapporre funzionalità avanzate di navigazione e ricerca.
Superfici di sistema
- livello delle route dell'app di documentazione
- livello dei componenti UI della documentazione
- dati CMS della documentazione e helper per gli URL