docdef/readme.md

34 lines
1 KiB
Markdown

# docdef
zum Erzeugen von Dokumenten anhand von JSON-Daten
## Erstellung
- `tools/ivaldi build` ausführen
## Nutzung
Am beigefügten Beispiel `polyhedra`:
```sh
misc/conv misc/examples/polyhedra/transform-default.js misc/examples/polyhedra/data.json | build/sd -o markdown > /tmp/polyhedra-default.md
```
Der erste Teil (vor der Pipe) transformiert die rohen Daten in ein ein JSON-Dokument im `sd`-Dialekt. `build/sd -o markdown` liest dieses Dokument von der Standard-Eingabe und erzeugt die Ausgabe im Markdown-Format.
Folgende Abwandlungen sind möglich:
```sh
# Markdown-Tabelle
cat misc/examples/polyhedra/data.json | misc/conv misc/examples/polyhedra/transform-table.js | build/sd -o markdown > /tmp/polyhedra-table.md
# HTML-Liste
cat misc/examples/polyhedra/data.json | misc/conv misc/examples/polyhedra/transform-default.js | build/sd -o html > /tmp/polyhedra-default.html
# HTML-Tabelle
cat misc/examples/polyhedra/data.json | misc/conv misc/examples/polyhedra/transform-table.js | build/sd -o html > /tmp/polyhedra-table.html
```