Comment personnaliser la documentation Docfx (thèmes ou modèles)?

Question

Je viens juste de commencer à utiliser Docfx et de mettre en place une documentation conceptuelle de base. Maintenant, je veux faire quelques ajustements au thème (logo de l'entreprise, peut-être quelques changements de police, etc.) choses mineures.

Le official documentation donne seulement une description de haut niveau sur la façon de créer un nouveau modèle. Je n'ai jamais utilisé de langage de gabarit auparavant, donc je voudrais éviter cela pour l'instant si possible.

Ma question est: comment puis-je faire de petits ajustements au thème par défaut, comme certains changements CSS et peut-être ajouter des ressources externes (comme police génial)?

Dois-je créer un modèle entier (ou une partie de celui-ci) ou puis-je inclure un fichier CSS en quelque sorte? La documentation mentionne une option theme mais jusqu'à présent, je n'ai trouvé aucun exemple ou thème existant à partir desquels apprendre. Un simple lien vers un projet utilisant un thème ou un modèle personnalisé serait déjà très utile. Le docfx repo a un dossier docfx.website.themes et le modèle par défaut est également là, je crois, mais je ne pouvais pas vraiment savoir quels fichiers je devais fournir pour rouler le mien.

Answer 1

1. modèle Export:
   • Run docfx template export default, vous verrez modèle par défaut dans _exported_templates\default
2. thèmes de changement dans le modèle par défaut, par exemple:
   • Ajout ressource externe: modifier styles\head.tmpl.partial
   • CSS modification: modifier styles\docfx.css ou styles\main.css
3. Utiliser un modèle personnalisé:
   • Run docfx -t _exported_templates\default, qui utilisera votre modèle personnalisé!

REMARQUE: Il est possible que DocFX met à jour ses modèles intégrés lors de la publication nouvelle version. Assurez-vous donc de réexporter le modèle si vous remplacez ou dépendez de ce modèle dans votre modèle personnalisé.