MkDocs verwendet die gleichen Grundsätze wie bei jeder anderen statische Website-Generator in der Umgebung.
Es erfordert die Entwickler, eine Konfigurationsdatei bearbeiten (MKDocs verwendet YAML für diese), erstellen Sie Seitenvorlagen (via Jinja2), und fügen Sie den Inhalt in einen speziellen Ordner (wie Markdown-Dateien).
Er kann dann öffnen Sie die Python-CLI laufen ein paar Befehle und eine endgültige HTML-Seite aus alle seine Ressourcen zusammenzubauen.
Wenn er etwas zu aktualisieren will, kann er alle seine Änderungen in der Originalquelle zu machen und neu kompilieren Sie die Seite über die Konsole.
Das Endprodukt ist eine Sammlung von HTML, CSS, JS und statische Vermögenswerte, die mit jeder Art von Web-Server auf dem Markt erhältlich gehostet werden können.
MkDocs unterstützt eine unbegrenzte Anzahl von Seiten, automatische Menü Generation endgültigen Website Themen, Seite Meta-Daten, und kommt mit einem Grundentwurf Struktur, auf der um loszulegen.
MkDocs arbeitet mit beiden Versionen der Programmiersprache Python, 2.x und 3.x
Was ist neu in dieser Pressemitteilung:.
- < li> Render 404.html Dateien, wenn sie für das aktuelle Thema vorhanden sind.
- Bugfix:
- Long nav Bars, Tisch Rendering und Code-Highlighting in MkDocs und ReadTheDocs Themen.
- Ein Problem mit dem google_analytics Code.
- __pycache__ entfernen aus dem Paket tar.
- Markdown-Links, die auf einen Anker auf der aktuellen Seite zu gehen.
- Schön auch CSS-Klassen für alle HTML Fügen Sie nicht, es nur in der MkDocs Thema hinzufügen.
- Anzeigeabschnittstitel in der ReadTheDocs Thema.
- Verwenden Sie die Wahlbeobachter in Watchdog so Wiederaufbau Arbeiten auf Dateisysteme ohne inotify.
- Erhöhen Sie Fehlerausgabe für gemeinsame Konfigurations Fehlern.
Was ist neu in der Version 0.13.3:
- Render 404.html Dateien, wenn sie für die existieren aktuelle Thema.
- Bugfix:
- Long nav Bars, Tisch Rendering und Code-Highlighting in MkDocs und ReadTheDocs Themen.
- Ein Problem mit dem google_analytics Code.
- __pycache__ entfernen aus dem Paket tar.
- Markdown-Links, die auf einen Anker auf der aktuellen Seite zu gehen.
- Schön auch CSS-Klassen für alle HTML Fügen Sie nicht, es nur in der MkDocs Thema hinzufügen.
- Anzeigeabschnittstitel in der ReadTheDocs Thema.
- Verwenden Sie die Wahlbeobachter in Watchdog so Wiederaufbau Arbeiten auf Dateisysteme ohne inotify.
- Erhöhen Sie Fehlerausgabe für gemeinsame Konfigurations Fehlern.
Was ist neu in der Version 0.12.2:
- Render 404.html Dateien, wenn sie für die existieren aktuelle Thema.
- Bugfix:
- Long nav Bars, Tisch Rendering und Code-Highlighting in MkDocs und ReadTheDocs Themen.
- Ein Problem mit dem google_analytics Code.
- __pycache__ entfernen aus dem Paket tar.
- Markdown-Links, die auf einen Anker auf der aktuellen Seite zu gehen.
- Schön auch CSS-Klassen für alle HTML Fügen Sie nicht, es nur in der MkDocs Thema hinzufügen.
- Anzeigeabschnittstitel in der ReadTheDocs Thema.
- Verwenden Sie die Wahlbeobachter in Watchdog so Wiederaufbau Arbeiten auf Dateisysteme ohne inotify.
- Erhöhen Sie Fehlerausgabe für gemeinsame Konfigurations Fehlern.
Was ist neu in der Version 0.11.1:
- Render 404.html Dateien, wenn sie für die existieren aktuelle Thema.
- Bugfix:
- Long nav Bars, Tisch Rendering und Code-Highlighting in MkDocs und ReadTheDocs Themen.
- Ein Problem mit dem google_analytics Code.
- __pycache__ entfernen aus dem Paket tar.
- Markdown-Links, die auf einen Anker auf der aktuellen Seite zu gehen.
- Schön auch CSS-Klassen für alle HTML Fügen Sie nicht, es nur in der MkDocs Thema hinzufügen.
- Anzeigeabschnittstitel in der ReadTheDocs Thema.
- Verwenden Sie die Wahlbeobachter in Watchdog so Wiederaufbau Arbeiten auf Dateisysteme ohne inotify.
- Erhöhen Sie Fehlerausgabe für gemeinsame Konfigurations Fehlern.
Anforderungen :
- Jinja 2.7.1 oder höher
- Markdown 2.3.1 oder höher
- PyYAML 3.1 oder höher
Kommentare nicht gefunden