diff --git a/readme.md b/readme.md index 87c9c39..83e8c1b 100644 --- a/readme.md +++ b/readme.md @@ -1,137 +1,13 @@ -# SimonUp statt Markdown 😉 - -Mein Enwurf für eine schreibfreundlichere Sprache. - -## Syntax - -### Textformatierung -``` -#Text# → Titel H1 -##Text## → Titel H2 -*Text* → Fett -_Text_ → Unterstrichen -/Text/ → Kursiv -~Text~ → Durchgestrichen -^Text^ → Hochgestellt -^^Text^^ → Tiefgestellt -\Zeichen → Escape (z. B. \# → #) -|Text| → Zentriert ->Text> → Einrücken ->>Text>> → 2x Einrücken -``` - -### Listen -``` --Text- → Liste -+Text+ → Nummerierte Liste -``` - -### Links -``` -[Text](URL) → Link -[Text]{URL} → Link new Tab -``` - -### Code -``` -`Text` → Code -``` - -### Bilder -``` -![Alt-Text](URL) → Bild mit Alt-Text -![Alt-Text w:200 h:150](URL) → Bild mit Alt-Text und Grösse definiert -![Alt-Text left/right/center](URL) → Positioniert -![Alt-Text left33%](URL) → Ausrichtung links, 33% der Seitenbreite -![Alt-Text](URL) |Unterschrift| → Bild mit Bildunterschrift -``` - -### Fussnoten -``` -^1[Text]^ → Fussnote manuelle Nummer + Text -^x[Text]^ → Fussnote automatische Nummer + Text -``` - -### Textblöcke -``` ->[c] Text> → Codeblock ->[c Sprache] Text> → Codeblock ->[q] Text> → Zitatblock ->[b] Text> → Bibel-Textblock -``` - - -# SimonUp Syntax-Spezifikation - -SimonUp ist eine moderne, fluss- und blockorientierte Auszeichnungssprache. Sie wurde entwickelt, um den Schreibfluss zu maximieren, die Finger-Akrobatik auf der Tastatur zu minimieren und die bekanntesten Schwachstellen von traditionellem Markdown elegant zu lösen. - ---- - -## Philosophie: Fluss vs. Block - -SimonUp trennt strikt zwischen zwei Logiken: -1. **Fluss-Formatierungen (Inline):** Werden mit *einem* einzelnen Zeichen geöffnet und geschlossen. Sie erlauben es, Formatierungen mitten im Satz zu nutzen, ohne eine neue Zeile zu erzwingen (z. B. Inline-Überschriften). Sie funktionieren auch innerhalb von Blöcken. -2. **Block-Formatierungen (Strukturell):** Beginnen *immer* am Zeilenanfang mit dem Kaufmanns-Und (`&`) plus einem Typ-Kürzel. Sie enden mit einem einzelnen `&` auf einer eigenen, neuen Zeile. - ---- - -## 1. Fluss-Formatierungen (Inline) - -| Syntax | Ergebnis | Besonderheit / Usecase | -| :--- | :--- | :--- | -| `#Text#` | **Überschrift H1** | Text kann direkt in der Zeile weiterfließen. | -| `##Text##` | **Überschrift H2** | Text kann direkt in der Zeile weiterfließen. | -| `*Text*` | **Medium** | Halbfette Betonung (`font-weight: 500`). | -| `**Text**` | **Fett** | Starke, fette Betonung (`font-weight: 700`) / Auch für Tabellenköpfe. | -| `/Text/` | *Kursiv* | Leichte Betonung / Zitate im Text. | -| `_Text_` | Unterstrichen | Sauberer, dokumentenähnlicher Textstil. | -| `~Text~` | ~~Durchgestrichen~~ | Korrekturen oder erledigte To-Dos. | -| `=Text=` | Leuchtstift / Highlight | Textmarker-Effekt für wichtige Schlüsselwörter. | -| `^Text^` | Hochgestellt | Mathematische Notation oder Indizes. | -| `°Text°` | Tiefgestellt | Chemische Formeln oder Indizes. | -| `` `Text` `` | `Inline-Code` | Technische Begriffe im Fließtext. | -| `\Zeichen` | *Escape* | Hebt die Bedeutung von Steuerzeichen auf (z. B. `\#`). | - -### Ausrichtung & Einrückung im Fluss -* `|Text|` → Der umschlossene Text wird **zentriert**. -* `>Text>` → Der umschlossene Text wird **1x eingerückt**. -* `>>Text>>` → Der umschlossene Text wird **2x eingerückt**. - ---- - -## 2. Block-Formatierungen - -### Listen -```text -&- -Erster Listenpunkt -Zweiter Listenpunkt -& - -### Textblöcke (Code, Zitate, Bibelstellen) -```text -&c python -def simonup(): - print("Fluss-Formatierungen werden hier ignoriert.") -& -``` - ---- - # SimonUp Syntax-Spezifikation SimonUp ist eine moderne, fluss- und blockorientierte Auszeichnungssprache (Dateiendung: `.up`). Sie wurde entwickelt, um den Schreibfluss zu maximieren, die Finger-Akrobatik auf der Tastatur zu minimieren und die Schwachstellen von traditionellem Markdown elegant zu lösen. ---- - ## Philosophie: Fluss vs. Block SimonUp trennt strikt zwischen zwei Logiken: 1. **Fluss-Formatierungen (Inline):** Werden mit *einem* einzelnen Zeichen (oder einer Verdopplung) geöffnet und geschlossen. Sie erlauben Formatierungen mitten im Satz, ohne eine neue Zeile zu erzwingen, und funktionieren auch innerhalb von Blöcken. 2. **Block-Formatierungen (Strukturell):** Beginnen *immer* am Zeilenanfang mit `&` plus einem Typ-Kürzel und enden mit einem einzelnen `&` auf einer eigenen, neuen Zeile. ---- - ## 1. Fluss-Formatierungen (Inline) | Syntax | Ergebnis | Besonderheit / Usecase | @@ -154,8 +30,6 @@ SimonUp trennt strikt zwischen zwei Logiken: * `>Text>` → Der umschlossene Text wird **1x eingerückt**. * `>>Text>>` → Der umschlossene Text wird **2x eingerückt**. ---- - ## 2. Block-Formatierungen ### Listen & Strukturen (`&-`, `&+`) @@ -216,8 +90,6 @@ Simon | Entwickler | Zürich ``` ---- - ## 3. Links, Medien & Fußnoten ### Links & Medien