MkDocs maakt gebruik van dezelfde principes als elke andere statische site generator in de buurt.
Het vereist de ontwikkelaar om een configuratiebestand bewerken (MKDocs gebruikt YAML voor deze), pagina templates (via Jinja2) te creëren, en voegt zijn inhoud in een speciale map (zoals Markdown bestanden).
Hij kan dan openen de Python CLI lopen een paar commando's en assembleren een uiteindelijke HTML-site van al zijn bronnen.
Als hij iets wil werken, kan hij al zijn veranderingen in de originele bron te maken en opnieuw te compileren van de site via de console.
Het eindproduct is een verzameling van HTML, CSS, JS en statische activa die kunnen worden gehost met elk type van de webserver op de markt.
MkDocs ondersteunt een onbeperkt aantal pagina's, automatisch genereren van menu's, de uiteindelijke website thema's, pagina meta-data, en wordt geleverd met een eenvoudige project structuur waarop aan de slag.
MkDocs werkt met beide versies van de Python taal, 2.x en 3.x
Wat is nieuw in deze release:.
- < li> Render 404.html bestanden als ze bestaan voor het huidige thema.
- Bugfix:
- Lange nav bars, een tafel rendering en code highlighting in MkDocs en ReadTheDocs thema's.
- Een probleem met de google_analytics code.
- Verwijder __pycache__ uit de verpakking teer.
- Markdown links die naar een anker op de huidige pagina.
- Niet prettyprint goed CSS-klassen toe te voegen aan alle HTML, alleen maar in de MkDocs thema.
- sectie Weergave titels in de ReadTheDocs thema.
- Gebruik de polling waarnemer waakhond zodat de wederopbouw werken op bestandssystemen zonder inotify.
- Verbetering fout uitgang voor de algehele configuratie gerelateerde fouten.
Wat is nieuw in versie 0.13.3:
- Render 404.html bestanden als ze bestaan voor de huidige thema.
- Bugfix:
- Lange nav bars, een tafel rendering en code highlighting in MkDocs en ReadTheDocs thema's.
- Een probleem met de google_analytics code.
- Verwijder __pycache__ uit de verpakking teer.
- Markdown links die naar een anker op de huidige pagina.
- Niet prettyprint goed CSS-klassen toe te voegen aan alle HTML, alleen maar in de MkDocs thema.
- sectie Weergave titels in de ReadTheDocs thema.
- Gebruik de polling waarnemer waakhond zodat de wederopbouw werken op bestandssystemen zonder inotify.
- Verbetering fout uitgang voor de algehele configuratie gerelateerde fouten.
Wat is nieuw in versie 0.12.2:
- Render 404.html bestanden als ze bestaan voor de huidige thema.
- Bugfix:
- Lange nav bars, een tafel rendering en code highlighting in MkDocs en ReadTheDocs thema's.
- Een probleem met de google_analytics code.
- Verwijder __pycache__ uit de verpakking teer.
- Markdown links die naar een anker op de huidige pagina.
- Niet prettyprint goed CSS-klassen toe te voegen aan alle HTML, alleen maar in de MkDocs thema.
- sectie Weergave titels in de ReadTheDocs thema.
- Gebruik de polling waarnemer waakhond zodat de wederopbouw werken op bestandssystemen zonder inotify.
- Verbetering fout uitgang voor de algehele configuratie gerelateerde fouten.
Wat is nieuw in versie 0.11.1:
- Render 404.html bestanden als ze bestaan voor de huidige thema.
- Bugfix:
- Lange nav bars, een tafel rendering en code highlighting in MkDocs en ReadTheDocs thema's.
- Een probleem met de google_analytics code.
- Verwijder __pycache__ uit de verpakking teer.
- Markdown links die naar een anker op de huidige pagina.
- Niet prettyprint goed CSS-klassen toe te voegen aan alle HTML, alleen maar in de MkDocs thema.
- sectie Weergave titels in de ReadTheDocs thema.
- Gebruik de polling waarnemer waakhond zodat de wederopbouw werken op bestandssystemen zonder inotify.
- Verbetering fout uitgang voor de algehele configuratie gerelateerde fouten.
Eisen
- Jinja 2.7.1 of hoger
- Markdown 2.3.1 of hoger
- PyYAML 3.1 of hoger
Reacties niet gevonden