Initial commit: added Markdown to IHK Chemnitz PDF converter with core structure and features, including YAML config, Goldmark parser, and PDF renderer.
This commit is contained in:
47
README.md
47
README.md
@@ -0,0 +1,47 @@
|
||||
# Markdown to IHK Chemnitz PDF Converter
|
||||
|
||||
Dieses Tool konvertiert Markdown-Dateien in professionelle Projektdokumentationen, die den formalen Anforderungen der **IHK Chemnitz** (IT-Berufe, Stand 2020/2026) entsprechen.
|
||||
|
||||
## Features
|
||||
|
||||
- **IHK-konforme Formatierung**: Automatische Einhaltung von Seitenrändern (30mm links, 40mm Korrekturrand rechts), Schriftarten und Zeilenabständen.
|
||||
- **Paging in Tabellen**:
|
||||
- **Tabellen-Pagination**: Automatisches Wiederholen der Kopfzeile auf Folgeseiten.
|
||||
- **Fortsetzungs-Markierung**: Kennzeichnung von umgebrochenen Tabellen mit "(Fortsetzung)".
|
||||
- **Tabellen-Fußzeile**: Seitennummerierung und Projektdaten in einer sauberen Tabellenstruktur am Seitenende.
|
||||
- **Diagramme via Kroki**: Unterstützung für Mermaid, PlantUML und andere Formate direkt im Markdown.
|
||||
- **Automatisierte Verzeichnisse**:
|
||||
- Inhaltsverzeichnis mit korrekter Paginierung (römisch/arabisch).
|
||||
- Literaturverzeichnis (sortiert).
|
||||
- Anlagenverzeichnis.
|
||||
- **Metadaten**: Einfache Konfiguration von Schüler- und Projektdaten via YAML-Frontmatter.
|
||||
|
||||
## Installation
|
||||
|
||||
Stellen Sie sicher, dass [Go](https://golang.org/) installiert ist.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ihk-markdown-renderer
|
||||
cd MarkdownToIHKChemnits
|
||||
go mod tidy
|
||||
```
|
||||
|
||||
## Benutzung
|
||||
|
||||
1. Erstellen Sie eine `report.md` mit YAML-Frontmatter (siehe Beispiel).
|
||||
2. Führen Sie den Konverter aus:
|
||||
|
||||
```bash
|
||||
go run . -i report.md -o projektarbeit.pdf
|
||||
```
|
||||
|
||||
## Projektstruktur
|
||||
|
||||
- `main.go`: Einstiegspunkt und Orchestrierung.
|
||||
- `markdown_parser.go`: AST-Parsing und Integration der Goldmark-Extensions.
|
||||
- `pdf_renderer.go`: FPDF-Logik für IHK-Layout, Tabellen-Paging und Fußzeilen.
|
||||
- `config.go`: Konfigurationsstrukturen.
|
||||
|
||||
## Lizenz
|
||||
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user