uEdition 2.0.0__tar.gz

uedition-2.0.0/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  # Check for updates of all GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Check for updates of all Python packages
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

uedition-2.0.0/.github/workflows/codestyle.yml

@@ -0,0 +1,41 @@
+name: Code Style
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python_version }}
+
+      - name: Add .local path
+        run: |
+          echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
+          echo "PIPX_HOME=$HOME/.local/pipx" >> $GITHUB_ENV
+          echo "PIPX_BIN_DIR=$HOME/.local/bin" >> $GITHUB_ENV
+
+      - name: Install Base Dependencies
+        run: |
+          sudo apt-get install python3-venv pipx
+          pipx install hatch
+
+      - name: Run Ruff check
+        run: |
+          hatch run ruff-check
+
+      - name: Run Ruff format check
+        run: |
+          hatch run ruff-format-check

uedition-2.0.0/.github/workflows/coverage.yml

@@ -0,0 +1,52 @@
+name: Coverage
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Add .local path
+      run: |
+        echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
+        echo "PIPX_HOME=$HOME/.local/pipx" >> $GITHUB_ENV
+        echo "PIPX_BIN_DIR=$HOME/.local/bin" >> $GITHUB_ENV
+
+    - name: Install Base Dependencies
+      run: |
+        sudo apt-get install python3-venv pipx
+        pipx install hatch
+
+    - name: Run Tests
+      run: |
+        hatch run cov
+
+    - name: Calculate coverage
+      run: |
+        hatch run coverage json
+        export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
+        echo "total=$TOTAL" >> $GITHUB_ENV
+        echo "### Total coverage: ${TOTAL}%" >> $GITHUB_STEP_SUMMARY
+
+    - name: "Make badge"
+      uses: schneegans/dynamic-badges-action@v1.7.0
+      with:
+        auth: ${{ secrets.GIST_TOKEN }}
+        gistID: 13b76c3c8e59fa624d03918fafde3f2d
+        filename: coverage.json
+        label: Coverage
+        message: ${{ env.total }}%
+        minColorRange: 50
+        maxColorRange: 90
+        valColorRange: ${{ env.total }}

uedition-2.0.0/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/uedition
+
+    permissions:
+      id-token: write
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: |
+          3.11
+
+    - name: Install Base Dependencies
+      run: |
+        pip install --user build
+
+    - name: Build the package
+      run: |
+        python -m build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

uedition-2.0.0/.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python_version }}
+
+      - name: Add .local path
+        run: |
+          echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
+          echo "PIPX_HOME=$HOME/.local/pipx" >> $GITHUB_ENV
+          echo "PIPX_BIN_DIR=$HOME/.local/bin" >> $GITHUB_ENV
+
+      - name: Install Base Dependencies
+        run: |
+          sudo apt-get install python3-venv pipx
+          pipx install hatch
+
+      - name: Run Tests
+        run: |
+          hatch run cov

uedition-2.0.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__
+.coverage*
+.python-version
+.pytest_cache
+coverage.json
+dist
+.vscode
+conf.py

uedition-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.5
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

uedition-2.0.0/.readthedocs.yml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  commands:
+    - "pip install hatch"
+    - "cd docs && hatch run build"
+    - "mkdir $READTHEDOCS_OUTPUT"
+    - "mv docs/site $READTHEDOCS_OUTPUT/html"
+
+python:
+  install:
+    - method: pip
+      path: .

uedition-2.0.0/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present Mark Hall <mark.hall@work.room3b.eu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

uedition-2.0.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: uEdition
+Version: 2.0.0
+Project-URL: Documentation, https://github.com/uEdition/uEdition#readme
+Project-URL: Issues, https://github.com/uEdition/uEdition/issues
+Project-URL: Source, https://github.com/uEdition/uEdition
+Author-email: Mark Hall <mark.hall@work.room3b.eu>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: httpx<0.29,>=0.28.1
+Requires-Dist: livereload
+Requires-Dist: lxml<6.0.0,>=4.9.2
+Requires-Dist: myst-parser<5,>=4.0.1
+Requires-Dist: packaging==24.2
+Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: pyyaml<7.0.0,>=6.0.0
+Requires-Dist: sphinx-book-theme<2,>=1.1.4
+Requires-Dist: sphinx-external-toc<2,>=1.0.1
+Requires-Dist: sphinx<9,>=8.2.3
+Requires-Dist: strictyaml<2,>=1.7.3
+Requires-Dist: tomlkit<0.14,>=0.13.2
+Requires-Dist: typer<1.0.0
+Description-Content-Type: text/markdown
+
+# μEdition
+
+The μEdition is a micro framwork for quickly building Editions.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/uedition.svg)](https://pypi.org/project/uedition)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/uedition.svg)](https://pypi.org/project/uedition)
+[![Test workflow status](https://github.com/uEdition/uEdition/actions/workflows/tests.yml/badge.svg)](https://github.com/uEdition/uEdition/actions/workflows/tests.yml)
+[![Test coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scmmmh/13b76c3c8e59fa624d03918fafde3f2d/raw/coverage.json)](https://github.com/uEdition/uEdition/actions/workflows/tests.yml)
+[![Documentation Status](https://readthedocs.org/projects/uedition/badge/?version=latest)](https://uedition.readthedocs.io/en/latest/?badge=latest)
+
+-----
+
+**Table of Contents**
+
+- [Quickstart](#quickstart)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Quickstart
+
+To quickly get started with the μEdition follow these steps:
+
+1. Install [Hatch](https://hatch.pypa.io/latest/install/) for your operating system.
+2. Create a new folder for your μEdition.
+3. Download the default {download}`https://uedition.readthedocs.io/latest/en_static/pyproject.toml` and move that into
+   your new folder.
+4. Open a new terminal, change into your new folder and run the following command:
+
+   :::{code-block} console
+   hatch run init
+   :::
+
+   This creates the configuration file ({file}`uEdition.yml`) and table of contents ({file}`toc.yml`).
+
+5. Then run the following command to add content in a new language:
+
+   :::{code-block} console
+   hatch run language add
+   :::
+
+   This will ask you a few questions about the new language and then create the required files.
+
+5. Then run the following command to start the writing server:
+
+   :::{code-block} console
+   hatch run serve
+   :::
+
+## Documentation
+
+Full documentation is available at [https://uedition.readthedocs.io](https://uedition.readthedocs.io).
+
+## License
+
+The μEdition is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

uedition-2.0.0/README.md

@@ -0,0 +1,55 @@
+# μEdition
+
+The μEdition is a micro framwork for quickly building Editions.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/uedition.svg)](https://pypi.org/project/uedition)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/uedition.svg)](https://pypi.org/project/uedition)
+[![Test workflow status](https://github.com/uEdition/uEdition/actions/workflows/tests.yml/badge.svg)](https://github.com/uEdition/uEdition/actions/workflows/tests.yml)
+[![Test coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scmmmh/13b76c3c8e59fa624d03918fafde3f2d/raw/coverage.json)](https://github.com/uEdition/uEdition/actions/workflows/tests.yml)
+[![Documentation Status](https://readthedocs.org/projects/uedition/badge/?version=latest)](https://uedition.readthedocs.io/en/latest/?badge=latest)
+
+-----
+
+**Table of Contents**
+
+- [Quickstart](#quickstart)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Quickstart
+
+To quickly get started with the μEdition follow these steps:
+
+1. Install [Hatch](https://hatch.pypa.io/latest/install/) for your operating system.
+2. Create a new folder for your μEdition.
+3. Download the default {download}`https://uedition.readthedocs.io/latest/en_static/pyproject.toml` and move that into
+   your new folder.
+4. Open a new terminal, change into your new folder and run the following command:
+
+   :::{code-block} console
+   hatch run init
+   :::
+
+   This creates the configuration file ({file}`uEdition.yml`) and table of contents ({file}`toc.yml`).
+
+5. Then run the following command to add content in a new language:
+
+   :::{code-block} console
+   hatch run language add
+   :::
+
+   This will ask you a few questions about the new language and then create the required files.
+
+5. Then run the following command to start the writing server:
+
+   :::{code-block} console
+   hatch run serve
+   :::
+
+## Documentation
+
+Full documentation is available at [https://uedition.readthedocs.io](https://uedition.readthedocs.io).
+
+## License
+
+The μEdition is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

uedition-2.0.0/docs/.gitignore

@@ -0,0 +1,5 @@
+_build
+site
+_toc.yml
+conf.py
+_static

uedition-2.0.0/docs/.readthedocs.yml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  commands:
+    - "pip install hatch"
+    - "hatch run build"
+    - "mkdir $READTHEDOCS_OUTPUT"
+    - "mv site $READTHEDOCS_OUTPUT/html"
+
+python:
+  install:
+    - method: pip
+      path: .

uedition-2.0.0/docs/de/changelog.md

@@ -0,0 +1,103 @@
+# Änderungsgeschichte
+
+## In Entwicklung
+
+* **Bruch**: Direkte Nutzung von Sphinx anstelle über Jupyter Book
+* **Bruch**: Keine Nutzung von Copier mehr
+* **Bruch**: TEI Parser und Konfiguration überarbeitet
+* **Entfernt**: Undokumentierten "check" Kommandozeilenbefehl entfernt
+
+## 1.x
+
+### 1.3.2 (26.02.2024)
+
+* **Bugfix**: Weiteren Fehler in der Sortierung nach Seitenzahlen behoben
+
+### 1.3.1 (26.02.2024)
+
+* **Bugfix**: Fehler in der Sortierung nach Seitenzahlen behoben
+
+### 1.3.0 (22.02.2024)
+
+* **Neu**: Unterstützung für Downloadlinks in TEI Dateien
+
+### 1.2.0 (06.02.2024)
+
+* **Neu**: TEI Funktion zum Parsen von ISO8601 Daten
+* **Bugfix**: Fehler im TEI Parsing von Metadaten behoben
+
+### 1.1.0 (02.02.2024)
+
+* **Neu**: TEI Textabschnitte können jetzt sortiert werden
+* **Bugfix**: Die Landungsseite funktioniert jetzt auch ohne JavaScript
+
+### 1.0.0 (31.01.2024)
+
+* **Neu**: TEI Output ist optional
+* **Aktualisiert**: JupyterBook auf Version 1 aktualisert
+* **Aktualisert**: Sprachwechsler wird nicht angezeigt, wenn nur eine Sprache konfiguriert ist
+* **Bugfix**: Einen Bug im Ausgabepfadname korrigiert
+* **Bugfix**: Einen Bug im Sprachwechsler behoben
+
+### 0.9.0 (26.01.2024)
+
+* **Neu**: TEI Output hinzugefügt
+* **Aktualisiert**: Bereits beantwortet Fragen überspringen
+
+### 0.8.0 (12.01.2024)
+
+* **Neu**: Unterstützung von Read the Docs als Publikationsplatform
+* **Bugfix**: Softwareabhängigkeiten aktualisiert
+
+### 0.7.0 (04.07.2023)
+
+* **Neu**: Unterstützung für zentrale, statische Dateien
+* **Bugfix**: Fehlende Fortschrittsanzeige hinzugefügt
+
+### 0.6.1 (04.07.2023)
+
+* **Aktualisiert**: Softwareabhängigkeiten aktualisiert
+
+### 0.6.0 (04.07.2023)
+
+* **Neu**: Zentrale Konfiguration und Inhaltsverzeichnis
+
+### 0.5.0 (30.06.2023)
+
+* **Neu**: Copier in die uEdition integriert
+
+### 0.4.0 (26.06.2023)
+
+* **Neu**: Sprachwechsler hinzugefügt
+
+### 0.3.1 (22.06.2023)
+
+* **Bugfix**: Sicherstellen dass der Ausgabepfad existiert
+
+### 0.3.0 (22.06.2023)
+
+* **Neu**: Startseite mit automatischer Spracherkennung integriert
+
+### 0.2.1 (16.06.2023)
+
+* **Bugfix**: Abschnittsformatierungsbug behoben
+
+### 0.2.0 (16.06.2023)
+
+* **Neu**: Das TEI Layout auf vertikal umgestellt
+
+### 0.1.0 (13.06.2023)
+
+* **Neu**: TEI Input hinzugefügt
+
+### 0.0.3 (17.05.2023)
+
+* **Bugfix**: Korrektur im Softwarepublikationsprozess
+
+### 0.0.2 (17.05.2023)
+
+* **Bugfix**: Ausgabepfad korrekt handhaben
+
+### 0.0.1 (17.05.2023)
+
+* **Neu**: Erste Version

uedition-2.0.0/docs/de/getting-started/configuration.md

@@ -0,0 +1,29 @@
+# Die μEdition konfigurieren
+
+Die μEdition und Sphinx sind sehr konfigurable. Sowohl die μEdition, wie auch die Sphinx Funktionalität
+werden über die {file}`uEdition.yml` (im Wurzelverzeichnis der μEdition) konfiguriert. Der folgende Block zeigt alle
+verfügbaren Konfigurationsoptionen:
+
+:::{code-block} yaml
+author:           # Die Autor:innen:information bestehend aus
+  name:           #   Dem Autor:in:namen
+  email:          #   Der E-Mailaddresse der/des Autor:in:s
+languages:        # Die in der μEdition konfigurierten Sprachen. Eine List, in der jeder Eintrag aus folgenden Teilen besteht:
+  - code:         #   Der ISO 639-1 zweistellige Sprachcode
+    label:        #   Der Text der in der Ausgabe für die Sprache angezeigt wird
+    path:         #   Der Dateipfad in dem das sprachspezifische Jupyter Book abgelegt ist
+output:           # Das Ausgabeverzeichnis für die komplette μEdition
+repository:       # Das Git Repository für diese μEdition:
+  url:            #   Die URL für das Repository
+title:            # Der Titel der μEdition in allen konfigurierten Sprachen. Jede konfigurierte Sprache muss vorkommen.
+  en:             #   Abbildung vom ISO 639-1 Sprachcode auf den natürlichsprachlichen Titel
+version: '2'      # Die Version der μEdition Konfigurationsdatei. Muss auf "2" gesetzt sein.
+sphinx_config:    # Enthält alle zusätzlichen Sphinx Konfigurationseinträge
+:::
+
+Alle Konfigurationselement der Datei sind optional und nicht angegebene Werte werden durch funktionierende Standardwerte
+ersetzt.
+
+Alle Sphinx Einstellungen können über den `sphinx_config` Eintrag konfiguriert werden. Alle Sphinxeinstellungen welche über
+den `sphinx_config` Schlüssel konfiguriert werden, werden für alle Sprachen genutzt. Die einzige Ausnahme ist die `title`
+Einstellung, für welche die μEdition immer den Titel der spezifischen Sprache nutzt.

uedition-2.0.0/docs/de/getting-started/content.md

@@ -0,0 +1,80 @@
+# Inhalte hinzufügen
+
+Die μEdition baut auf [Sphinx](https://www.sphinx-doc.org/) auf um aus den Inhalten eine Webseite zu generieren,
+welche dann veröffentlicht werden kann. Jede Sprache in der μEdition ist ein eigenes Sphinx Dokument und die
+μEdition fügt die einzelnen Ausgaben in eine gemeinsame Webseite zusammen. Die μEdition lädt auch automatisch
+die [MyST](https://myst-parser.readthedocs.io/en/latest/) Erweiterung, damit Inhalte in Markdown erstellt werden können.
+
+## Die μEdition strukturieren
+
+Die Struktur der μEdition wird über das Inhaltsverzeichnis definiert, welches in der {file}`toc.yml` Datei
+(im Wurzelverzeichnis der μEdition) konfiguriert wird. Die {file}`toc.yml` Datei nutzt das Format
+[der zugrundeliegenden Jupyter Book Technik](https://jupyterbook.org/en/stable/structure/toc.html) und die
+Anfängliche {file}`toc.yml` sieht wie folgt aus:
+
+:::{code-block} yaml
+format: jb-book
+root: index
+:::
+
+Wichtig hier ist die `root: index` Einstellung, welche festlegt, dass eine Datei mit dem Namen {file}`index`
+als Anfangsseite genutzt wird. Im Dateiordner der ersten Sprache gibt es eine Datei {file}`index.md`, deren
+Inhalt die Anfangsseite der μEdition beinhaltet.
+
+Um der μEdition Seiten hinzuzufügen, müssen diese in Kapitel organisiert werden. Zum Beispiel um zwei Kapitel
+"richtlinien" und "kontakt" hinzuzufügen, aktualisieren sie die {file}`toc.yml` wie folgt:
+
+:::{code-block} yaml
+format: jb-book
+root: index
+chapters:
+  - file: richtlinien
+  - file: kontakt
+:::
+
+Dann legen sie zwei Dateien {file}`richtlinien.md` und {file}`kontakt.md` im Dateiordner der Sprache an und
+fügen dort die gewünschten Inhalte ein. Stellen sie sicher, dass der Dateiname jedes `file:` Eintrages ein
+relativer Dateipfad ist, der vom Dateiordner der Sprache auf die Datei verweist.
+
+Weiter Details über die Konfigurationsmöglichkeiten des Inhaltsverzeichnisses finden sie in der
+[Dokumentation des Jupyter Book Inhaltsverzeichnises](https://jupyterbook.org/en/stable/structure/toc.html).
+
+Standardmäßig wird der Titel des Dokuments als Titel im Inhaltsverzeichnis genutzt. Es ist jedoch möglich
+einen alternativen Titel zu konfigurieren, indem ein `caption` oder `title` Eintrag bereitgestellt wird.
+Die μEdition erweitert diese Funktionalität und ermöglicht es für jede konfigurierte Sprache einen eigenen
+Titel zu konfigurieren:
+
+:::{code-block} yaml
+format: jb-book
+root: index
+parts:
+  - caption:
+      en: Name of Part 1
+      de: Name von Teil 1
+    chapters:
+    - title:
+        en: Chapter 1
+        de: Chapter 2
+      file: path/to/part1/chapter1
+    - file: path/to/part1/chapter2
+:::
+
+## Texte schreiben
+
+Markedly Structured Text ist das primäre Format um die Textinhalte zu erstellen. Eine gute Übersicht über die
+Kernfunktionalität [findet sich hier](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html) und Erweiterungen
+die Jupyter Book bereitstellt [sind hier dokumentiert](https://jupyterbook.org/en/stable/content/index.html)
+und dokumentiert das einfache Erstellen von Aspekten wie Glossar, Index, Zitierbarkeit, Fußnoten und Layoutstrukturen.
+
+## Lokaler Server
+
+Während des Schreibprozesses kann es hilfreich sein zu sehen, wie das Ergebnis aussieht. Um dies zu vereinfachen stellt
+die μEdition einen eingebauten Webserver zur verfügung, der die generierte μEdition automatisch aktualisiert, wenn die
+Inhalte bearbeitet werden. Um den Server zu starten wird folgender Befehl genutzt:
+
+:::{code-block} console
+$ hatch run serve
+:::
+
+This generiert die μEdition und macht sie dann unter http://localhost:8000 verfügbar. Wenn die Inhalte geändert werden,
+wird die μEdition automatisch neugeneriert und die Seite im Browser automatisch neugeladen.

uedition-2.0.0/docs/de/getting-started/create.md

@@ -0,0 +1,17 @@
+# Eine μEdition erstellen
+
+Jetzt wo alle Vorraussetzungen installiert sind, kann die erste μEdition erstellt werden. Erstellen sie einen
+neuen Dateiordner für die neue μEdition. Dann laden sie die {download}`../_static/pyproject.toml` herunter
+und speichern sie diese im neuen Dateiordner ab.
+
+Dann navigieren sie auf der Kommandozeile in den neuen Dateiordner und führen folgenden Befehl aus:
+
+:::{code-block} console
+$ hatch run init
+:::
+
+Dies erstellt eine virtuelle Python Installation mit allen Softwarepaketen die die μEdition benötigt und führt
+dann den Initialisierungsvorgang aus. Dies erzeugt die Dateien {file}`uEdition.yml`, welche die Konfigurationseinstellungen
+beinhaltet, und {file}`toc.yml`, welche das Inhaltsverzeichnis beinhaltet.
+
+Der nächste Schriftt ist es der μEdition eine Sprache hinzuzufügen, damit die Inhalte bearbeitet werden können.

uedition-2.0.0/docs/de/getting-started/index.md

@@ -0,0 +1,8 @@
+# Erste Schritte
+
+Die ersten Schritte Dokumentation leitet die Herausgeber durch die Abläufe zum
+{doc}`Erstellen einer neuen μEdition <create>`, {doc}`hinzufügen einer Sprache <language-add>`,
+{doc}`Erstellung von Inhalten <content>` und {doc}`Veröffentlichen <publish>`.
+
+Die Anleitung erwartet keine großen, technischen Vorkenntnisse, ausser Grundkenntnisse über die Nutzung der
+Kommandozeile.

uedition-2.0.0/docs/de/getting-started/installation.md

@@ -0,0 +1,26 @@
+# Installation
+
+Die μEdition nutzt Python und unterstützt alle aktuell unterstützten Versionen[^python-version]. Bitte
+[installieren sie die Python Version für ihr Betriebssystem](https://python.org/downloads).
+
+Die μEdition nutzt [Hatch](https://hatch.pypa.io) um die Python Packete der μEdition zu verwalten. Bitte installieren
+sie die aktuellste Version für ihr Betriebssystem.
+
+Um zu Testen ob Python und Hatch korrekt installiert wurden, führen sie die folgenden zwei Befehle auf der Kommandozeile
+aus[^kein-prompt]:
+
+:::{code} console
+$ python --version
+$ hatch
+:::
+
+Wenn dies die aktuell installierte Python Version und eine Liste von Hatch Befehlen anzeigt, dann war die Installation
+erfolgreich.
+
+Um im Team zusammenzuarbeiten und für die GitHub Pages Veröffentlichungsfunktionalität, muss auch das Versionskontrollwerkzeug
+[Git](https://git-scm.com/downloads) installiert sein. Eine vollständige Einführung in Git übersteigt den Platz hier,
+aber es gibt viele gute Tutorials im Netz und die [offizielle Dokumentation](https://git-scm.com/doc) ist auch hilfreich.
+
+[^python-version]: Hier finden sie die [aktuell unterstützten Python Versionen](https://devguide.python.org/versions/)
+[^kein-prompt]: Das `$` Zeichen darf nicht eingegeben werden, wenn der Befehl ausgeführt wird. Das `$` wird nur genutzt um
+  hier anzuzeigen, dass es sich um ein Befehl und nicht um ein Programmergebnis handelt.