MDwiki – Ein Wiki mit Markdown und statischen Dateien

Das Wiki mit dem Namen MDwiki benötigt nur einen modernen Browser zur Darstellung und einen beliebigen Texteditor zum Bearbeiten der Inhalte, da sich diese nicht im Wiki selbst bearbeiten lassen.

Zur Installation muss man lediglich eine einzige html-Datei in einem eigenen Verzeichnis ablegen und diese im Browser aufrufen.

Jede Seite des MDwiki entspricht dabei einer Datei im Wiki-Verzeichnis mit der Endung .md, d. h. es wird MarkDown für die Formatierungen verwendet. Eine Dokumentation mit Beispielen findet sich hier.

Hier die Verzeichnisstruktur meines lokalen Wikis:

mdwiki_preview_files

Es ist egal, ob die statischen Dateien des Wikis auf irgend einem Webserver liegen oder zuhause in einem Verzeichnis auf der Festplatte von Linux, Windows, whatever.

Man muss nur die Datei mdwiki.html aufrufen und als Parameter den Namen der .md-Datei.

Z. B. in Firefox:

file:///pfad/zum/wiki/mdwiki.html#!chronicles.md

Layout

Per Voreinstellung wird links an der Seite das Inhaltsverzeichnis der H1-Überschriften angezeigt, sobald mindestens zwei solche in der aktuellen Seite vorhanden sind.

mdwiki_preview_layout

Das Layout verhält sich responsive und je nach Größe des Displays werden Elemente ausgeblendet; das Wiki eignet sich somit auch für mobile Geräte.

Fügt man Bilder ein, so werden diese beim Anklicken in einem kleinen Overlay geöffnet.

Navigation

Benötigt man eine Navigation am oberen Rand des Wikis, so erstellt man die Datei navigation.md.

Dort fügt man nach einem definierten Schema die Menüstruktur ein.

Eine Hilfe dazu gibt es hier.

Die Navigation wird automatisch auf jeder Seite dargestellt.

Ausprobieren

Die für ein eigenes Wiki benötigten Dateien gibt es hier.

Denn Quelltext findet man auf GitHub, siehe hier.

Wer solch ein Wiki in live sehen möchte, guckt sich am besten mal die Webseite des Projekts an, diese ist nämlich auch ein MDwiki :)

Oder eine der verlinkten Webseiten.

Was mir nicht gefällt

Habe bisher keine Möglichkeit gefunden, die Größe von Bildern einzustellen; anscheinend werden diese automatisch skaliert wenn mehrere hintereinander eingefügt werden. Aber einzelne Bilder werden immer in der vollen Auflösung dargestellt.

Eine Suchfunktion gibt es nicht.

\o/

Habe jetzt ein eigenes, lokales MDWiki aufgesetzt für den Zweck einer dokumentarischen Arbeit auf Zeit; bisher gefällt es mir gut.

Gefunden habe ich diese Projekt übrigens letztes Jahr bei onethingwell.org, es aber erst heute für mein Projekt benötigt.

Ähnliche Themen …

Ein Gedanke zu „MDwiki – Ein Wiki mit Markdown und statischen Dateien“

  1. Abgesehen von den wirklich sehr guten Beiträgen, finde ich den Blog als äusserst ansprechend und übersichtlich. Meiner hätte vielleicht so aussehen sollen.

    Grüß Dich Natchess

    Postman

Kommentare sind geschlossen.