Ich habe Django persönlich gemacht, aber da die Servergebühr nicht dumm ist, habe ich begonnen, den statischen Site-Generator zu untersuchen. Gatsby scheint auf den Straßen beliebt zu sein, aber ich möchte es mit Python so einfach wie möglich machen, also werde ich über MkDocs schreiben. Bitte beachten Sie, dass sich dieser Artikel nicht mit selbst erstellten Themen befasst, sondern auf vorhandene Themen und deren Anpassungen beschränkt ist.
Es wird in Offizielle Dokumente beschrieben, aber wenn Sie das standardmäßig installierte Thema verwenden, heißt es `Thema: Themenname Alles was Sie tun müssen, ist einen Satz in ``mkdocs.yml``` zu schreiben.
Wenn Sie beispielsweise das Thema "read theedocs" festlegen möchten, müssen Sie nur den Satz "theme: readthedocs" hinzufügen. Es ist einfach!
MkDocs hat viele Themen, die von der Community erstellt wurden. Das bekannteste davon ist das `` `mkdocs-Material```, das Materialdesign beinhaltet. Das Einbeziehen externer Themen ist ebenfalls recht einfach
pip install mkdocs-material
Von
mkdocs.yml
theme:
name: material
Mach einfach. Weitere Informationen zu diesem Thema finden Sie auf der offiziellen Github-Seite (URLhttps://github.com/squidfunk/mkdocs-material). Es gibt viele andere interessante und praktische Themen auf dieser Seite (URL https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes). Bitte probieren Sie es aus.
Wenn Sie nur CSS oder Javascript hinzufügen möchten, ist dies sehr einfach. Legen Sie einfach die CSS- oder Javascript-Dateien, die Sie hinzufügen möchten, in das Dokumentationsverzeichnis. Es wird ausführlicher in [hier](URL https://www.mkdocs.org/user-guide/configuration/#extra_css) beschrieben, aber beispielsweise im Dokumentationsverzeichnis.
extra_css:
- css/extra.css
- css/second_extra.css
Eine solche Struktur fügt extra_css mit einem Unterverzeichnis namens css hinzu. Sie können Javascript auf die gleiche Weise hinzufügen.
Gemäß den offiziellen Dokumenten muss zum Anpassen des Themas ein neues Verzeichnis auf derselben Ebene wie das Dokumentationsverzeichnis erstellt werden. ..
mkdocs custom_theme
Sobald Sie dies getan haben, teilen wir Ihnen mit, wo sich das benutzerdefinierte Thema in `` `mkdocs.yml``` befindet.
mkdocs.yml
theme:
name: mkdocs
custom_dir: custom_theme/
Wenn Sie eine Datei mit demselben Dateinamen erstellen wie die Datei, die in dem in custom_dir verwendeten Design enthalten ist, wird die Datei des aktuell verwendeten Designs automatisch durch die neu erstellte Datei ersetzt. Wenn Sie eine Datei mit einem Namen erstellen, der nicht in dem von Ihnen verwendeten Thema enthalten ist, wird diese automatisch zum vorhandenen Thema hinzugefügt.
Es ist einfacher, `` base.html``` zu erben, wenn eine HTML-Datei überschrieben wird (es sei denn natürlich, wenn `base.html``` selbst überschrieben wird).
{% extends "base.html" %}
{% block htmltitle %}
<title>Custom title goes here</title>
{% endblock %}
Sie können leicht erben, indem Sie einen Vorlagenblock auf diese Weise schreiben. Dies ist auch in der oben genannten offiziellen Dokumentation aufgeführt.
Ich werde vielleicht bald einen Artikel über meine eigene Arbeit zu diesem Thema schreiben. Wenn Sie Fehler finden, würden wir uns freuen, wenn Sie uns aktiv Bearbeitungsanfragen senden könnten.
MkDocs Material for MkDocs Styling your docs Custom themes
Recommended Posts