48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
# Ziel
|
|
|
|
Ziel des Paketes ist es alle Seiten eines MediWikis so zu konvertieren das sie direkt in Obsidian verwendete werden können.
|
|
|
|
Das Paket lädt dafür alle Seiten eines MediaWikis herunter und speichert sie in einem Ordner als Markdown file.
|
|
|
|
## Bestandteile
|
|
|
|
* Wikiseiten (Lemma) werden mit ihrem Titel als Dateinamen abgelegt
|
|
* Seiten die eine scheinbare Struktur in Form von slashes (/) im Namen haben werden in entsprechenden Unterordnern abgelegt
|
|
* Es wird die MediaWiki API verwendet um alle Seiten herunterzuladen.
|
|
* es wird html2text verwendet um die Seiten von HTML in Markdown zu konvertieren
|
|
* Meta-informationen der Seite werden am Ende in einem json gespeichert
|
|
* Dateien werden in einem separaten Ordner gespeichert un im Metadaten json richtig verlinkt
|
|
* Wikiseiten die zwar erstellt sind aber keinen Inhalt haben werden ignoriert
|
|
* entfernt aktuell nur deutschsprachigen links zum Abschnitt bearbeiten: "[Bearbeiten]" und "[Quelltext bearbeiten]
|
|
* Tabellen werden aktuell noch nicht richtig importiert
|
|
* revisionen werden in Metadata gespeichert mit timestamp und comment (falls vorhanden)
|
|
|
|
### Metadaten JSON
|
|
|
|
´´´
|
|
{
|
|
"metadata": {
|
|
"categories": [],
|
|
"internallinks": [],
|
|
"externallinks": [],
|
|
"images": [],
|
|
"showtoc": false
|
|
}
|
|
´´´
|
|
|
|
|
|
# Get started
|
|
## Install python environment
|
|
|
|
```
|
|
python3 -m venv .venv
|
|
|
|
source .venv/bin/activate # Für Unix/Mac
|
|
.venv\Scripts\activate # Für Windows
|
|
|
|
pip install -r requirements.txt
|
|
```
|
|
## Konfiguration
|
|
|
|
Kopiere die datei `config.json.tmpl` zu `config.json` und passe die Einstellungen darin an.
|