Pourquoi il existe
Nous proposons une application axée sur la documentation qui prouve que le contenu géré par un CMS peut être transformé en un site de documentation soigné sans reconstruire la couche de rendu.
À utiliser lorsque
- héberger la documentation produit par-dessus du contenu du CMS
- rendre des documents fortement basés sur Markdown
- créer une navigation de documentation via une barre latérale et la recherche
Ce que cela inclut
- application Next.js docs-template
- rendu des routes catch-all pilotées par le CMS
- limite Markdown dédiée aux docs
- composants de barre de navigation, de barre latérale et de contenu spécifiques aux docs
- chargement des publications et des catégories tenant compte de la langue
Flux de travail principal
- Configurez l'application de documentation avec les variables d'environnement du CMS.
- Rendez les routes de documentation via
cms-renderer. - Récupérez les documents de catégories et d’articles à partir des schémas du CMS.
- Rendez le contenu Markdown avec des composants spécifiques à la documentation.
- Superposez une navigation et une recherche plus riches par-dessus.
Surfaces du système
- couche de routage de l'application de documentation
- couche de composants d’interface de documentation
- utilitaires de données CMS et d’URL pour la documentation
