MkDocs använder samma principer som alla andra statisk webbplats generator runt.
Det kräver utvecklaren att redigera en konfigurationsfil (MKDocs använder YAML för detta), skapa sidmallar (via Jinja2), och lägg till hans innehåll i en särskild mapp (som Wiki-filer).
Han kan sedan öppna Python CLI köra några kommandon och montera en slutlig HTML webbplats från alla sina resurser.
Om han vill uppdatera något, kan han göra alla sina ändringar i den ursprungliga källan och åter sammanställa webbplats via konsolen.
Slutprodukten är en samling av HTML, CSS, JS och statiska tillgångar som kan finnas med någon typ av webbserver som finns på marknaden.
MkDocs stöder ett obegränsat antal sidor, automatisk meny generation, slut webbplats teman, sidan metadata, och kommer med ett grundläggande projekt struktur som att komma igång.
MkDocs arbetar med båda versionerna av Python-språket, 2.x och 3.x
Vad är nytt i den här versionen.
- < li> Render 404.html filer om de finns för det aktuella temat.
- Bugfix:
- Long nav barer, bord rendering och kod markera i MkDocs och ReadTheDocs teman.
- Ett problem med google_analytics kod.
- Ta __pycache__ ur förpackningen tar.
- Wiki länkar som går till ett ankare på den aktuella sidan.
- Inte lägga pretty väl CSS-klasser för alla HTML, bara lägga den i MkDocs tema.
- Display Rubrikerna i ReadTheDocs tema.
- Använd röstningen observatör i vakthund så återuppbygga arbeten på filsystem utan inotify.
- Förbättra fel utgång för vanliga konfigurationsrelaterade fel.
Vad är nytt i version 0.13.3:
- Render 404.html filer om de finns för aktuellt tema.
- Bugfix:
- Long nav barer, bord rendering och kod markera i MkDocs och ReadTheDocs teman.
- Ett problem med google_analytics kod.
- Ta __pycache__ ur förpackningen tar.
- Wiki länkar som går till ett ankare på den aktuella sidan.
- Inte lägga pretty väl CSS-klasser för alla HTML, bara lägga den i MkDocs tema.
- Display Rubrikerna i ReadTheDocs tema.
- Använd röstningen observatör i vakthund så återuppbygga arbeten på filsystem utan inotify.
- Förbättra fel utgång för vanliga konfigurationsrelaterade fel.
Vad är nytt i version 0.12.2:
- Render 404.html filer om de finns för aktuellt tema.
- Bugfix:
- Long nav barer, bord rendering och kod markera i MkDocs och ReadTheDocs teman.
- Ett problem med google_analytics kod.
- Ta __pycache__ ur förpackningen tar.
- Wiki länkar som går till ett ankare på den aktuella sidan.
- Inte lägga pretty väl CSS-klasser för alla HTML, bara lägga den i MkDocs tema.
- Display Rubrikerna i ReadTheDocs tema.
- Använd röstningen observatör i vakthund så återuppbygga arbeten på filsystem utan inotify.
- Förbättra fel utgång för vanliga konfigurationsrelaterade fel.
Vad är nytt i version 0.11.1:
- Render 404.html filer om de finns för aktuellt tema.
- Bugfix:
- Long nav barer, bord rendering och kod markera i MkDocs och ReadTheDocs teman.
- Ett problem med google_analytics kod.
- Ta __pycache__ ur förpackningen tar.
- Wiki länkar som går till ett ankare på den aktuella sidan.
- Inte lägga pretty väl CSS-klasser för alla HTML, bara lägga den i MkDocs tema.
- Display Rubrikerna i ReadTheDocs tema.
- Använd röstningen observatör i vakthund så återuppbygga arbeten på filsystem utan inotify.
- Förbättra fel utgång för vanliga konfigurationsrelaterade fel.
Krav :
- Jinja 2.7.1 eller senare
- Wiki 2.3.1 eller senare
- PyYAML 3.1 eller senare
Kommentarer hittades inte