Je faisais Django personnellement, mais comme les frais de serveur ne sont pas stupides, j'ai commencé à enquêter sur le générateur de site statique. Gatsby semble être populaire dans les rues, mais je veux le rendre aussi simple que possible avec Python, donc j'écrirai sur MkDocs. Veuillez noter que cet article ne traite pas des thèmes créés par vous-même, mais est limité aux thèmes existants et à leurs personnalisations.
Bien qu'il soit décrit dans Documents officiels, lors de l'utilisation du thème installé par défaut, il s'appelle thème: nom du thème '' ' Tout ce que vous avez à faire est d'écrire une phrase dans mkdocs.yml```.
A titre d'exemple, si vous souhaitez définir le thème `read thedocs , il vous suffit d'ajouter la phrase theme: readthedocs`. C'est facile!
MkDocs a de nombreux thèmes créés par la communauté. Le plus célèbre d'entre eux est le `` matériau mkdocs '' qui intègre la conception matérielle. Il est assez facile d’incorporer des thèmes externes.
pip install mkdocs-material
De
mkdocs.yml
theme:
name: material
Fais juste. Voir la page officielle github (URLhttps://github.com/squidfunk/mkdocs-material) pour plus d'informations à ce sujet. Il existe de nombreux autres thèmes intéressants et pratiques sur [cette page](URL https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes). Vérifie s'il te plaît.
Si vous souhaitez simplement ajouter du CSS ou du Javascript, c'est très simple. Mettez simplement les fichiers CSS ou Javascript que vous souhaitez ajouter dans le répertoire Documentation. Il est décrit en détail dans [ici](URL https://www.mkdocs.org/user-guide/configuration/#extra_css), mais par exemple, il se trouve dans le répertoire de documentation.
extra_css:
- css/extra.css
- css/second_extra.css
Une structure comme celle-ci ajoute extra_css avec un sous-répertoire appelé css. Vous pouvez ajouter du Javascript de la même manière.
Selon les Documents officiels, la personnalisation du thème nécessite la création d'un nouveau répertoire au même niveau que le répertoire de documentation. ..
mkdocs custom_theme
Une fois que vous avez fait cela, nous allons vous dire où se trouve votre thème personnalisé dans `` mkdocs.yml```.
mkdocs.yml
theme:
name: mkdocs
custom_dir: custom_theme/
Si vous créez un fichier avec le même nom de fichier que le fichier inclus dans le thème utilisé dans custom_dir, le fichier du thème que vous utilisez actuellement sera automatiquement remplacé par le fichier nouvellement créé. De plus, si vous créez un fichier avec un nom qui n'est pas inclus dans le thème que vous utilisez, il sera automatiquement ajouté au thème existant.
Il est plus facile d'hériter de base.html lors de l'écrasement d'un fichier html (sauf bien sûr lors de l'écrasement de `` `` base.html lui-même).
{% extends "base.html" %}
{% block htmltitle %}
<title>Custom title goes here</title>
{% endblock %}
Vous pouvez facilement hériter en écrivant un bloc de modèle de cette manière. Ceci est également détaillé dans la documentation officielle mentionnée ci-dessus.
Je vais peut-être bientôt écrire un article sur mon propre travail sur le thème. Si vous constatez des erreurs, nous vous serions reconnaissants de bien vouloir nous envoyer activement des demandes de modification.
MkDocs Material for MkDocs Styling your docs Custom themes
Recommended Posts