Skapa dokumentation med MkDocs was last modified: Dec 14th, 2015 by Albin Kiland

Skapa dokumentation med MkDocs

25
jun
2015
Albin Kiland blogg
MkDocs

Som du säkert vet är det viktigt med dokumentation av större projekt, vilket gör att vissa skruvar lite på sig då det kan vara  svårt och inte alltid det smidigaste.

Så, jag tänkte tipsa om ett program som heter MkDocs som används för att väldigt enkelt skapa tilltalande, lätt och funktionell dokumentation i HTML-format. Det som gör det hela enkelt är att du skriver din dokumentation i Markdown(md)-format som sedan konverteras av MkDocs till HTML som du kan ladda upp på vilken webbserver som helst!
Eftersom jag skriver i md-format kan jag väl inte se resultatet innan sidan är konverterad till HTML? Jo! MkDocs har en inbyggd webbserver du startar som i sin tur konverterar dina md-filer till HTML on-the-fly så du kan se resultatet i din webbläsare direkt när du gör ändringar.

För att börja måste du installera MkDocs på din dator. (instruktioner för OS X…):
1. Installera Python PIP.
sudo easy_install pip

2. Installera MkDocs
sudo pip install mkdocs

När allt är installerat är det bara att sätta igång!
Stanna i Terminalen och gå till den mapp där du vill skapa din dokumentation.
Skriv in detta kommando för att låta MkDocs skapa grundfilerna åt dig för att börja:
mkdocs new

Du bör nu ha följande struktur i mappen:
…docs
……index.md
…mkdocs.yml

Vårt administrationssystem SEAL har sina Hjälp-dokument skrivna i MkDocs(se bild)
SEAL - MkDocs

Mer än så här går jag inte igenom här utan jag slänger iväg dig till MkDocs dokumentation där alla inställningar och annat finns! Lycka till!

Webb: Mk Docs
MD-Spec: Markdown Cheatsheet