Documentation Site Template

Pourquoi il existe

Nous fournissons une application axée sur la documentation qui démontre que du 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 CMS
• rendre des documents riches en Markdown
• créer une navigation de documentation basée sur une barre latérale et la recherche

Ce qu'il comprend

• application Next.js modèle-de-docs
• rendu d'une route catch-all alimentée par le CMS
• limite Markdown pour la documentation
• composants de barre de navigation, de barre latérale et de contenu spécifiques à la documentation
• chargement des articles et catégories tenant compte de la langue

Flux de travail principal

1. Configurez l'application de documentation avec les variables d'environnement du CMS.
2. Rendez les routes de la documentation via cms-renderer.
3. Récupérez les documents de catégories et d'articles à partir des schémas du CMS.
4. Rendez le contenu Markdown avec des composants spécifiques à la documentation.
5. Superposez une navigation et une recherche plus riches par-dessus.

Surfaces du système

• couche de routes de l'application de documentation
• couche de composants d'interface de documentation
• assistants de données et d'URL CMS pour la documentation