Update readme.md
This commit is contained in:
simonpipe
parent
9354423e9d
commit
44fb4a1a92
1 changed files with 144 additions and 6 deletions
150
readme.md
150
readme.md
|
|
@ -1,4 +1,4 @@
|
|||
# Simonhigh statt Markdown 😉
|
||||
# SimonUp statt Markdown 😉
|
||||
|
||||
Mein Enwurf für eine schreibfreundlichere Sprache.
|
||||
|
||||
|
|
@ -61,15 +61,15 @@ _Text_ → Unterstrichen
|
|||
```
|
||||
|
||||
|
||||
# Simonhigh Syntax-Spezifikation
|
||||
# SimonUp Syntax-Spezifikation
|
||||
|
||||
Simonhigh 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.
|
||||
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
|
||||
|
||||
Simonhigh trennt strikt zwischen zwei Logiken:
|
||||
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.
|
||||
|
||||
|
|
@ -81,13 +81,14 @@ Simonhigh trennt strikt zwischen zwei Logiken:
|
|||
| :--- | :--- | :--- |
|
||||
| `#Text#` | **Überschrift H1** | Text kann direkt in der Zeile weiterfließen. |
|
||||
| `##Text##` | **Überschrift H2** | Text kann direkt in der Zeile weiterfließen. |
|
||||
| `*Text*` | **Fett** | Starke Betonung / Auch für Tabellenköpfe. |
|
||||
| `*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_` | <u>Unterstrichen</u> | Sauberer, dokumentenähnlicher Textstil. |
|
||||
| `~Text~` | ~~Durchgestrichen~~ | Korrekturen oder erledigte To-Dos. |
|
||||
| `=Text=` | <mark>Leuchtstift / Highlight</mark> | Textmarker-Effekt für wichtige Schlüsselwörter. |
|
||||
| `^Text^` | <sup>Hochgestellt</sup> | Mathematische Notation oder Indizes. |
|
||||
| `^^Text^^` | <sub>Tiefgestellt</sub> | Chemische Formeln oder Indizes. |
|
||||
| `°Text°` | <sub>Tiefgestellt</sub> | Chemische Formeln oder Indizes. |
|
||||
| `` `Text` `` | `Inline-Code` | Technische Begriffe im Fließtext. |
|
||||
| `\Zeichen` | *Escape* | Hebt die Bedeutung von Steuerzeichen auf (z. B. `\#`). |
|
||||
|
||||
|
|
@ -107,3 +108,140 @@ 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 |
|
||||
| :--- | :--- | :--- |
|
||||
| `#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 (Bold)** | Starke Betonung (`font-weight: 700`) / Tabellenkopf. |
|
||||
| `/Text/` | *Kursiv* | Leichte Betonung / Zitate im Text. |
|
||||
| `_Text_` | <u>Unterstrichen</u> | Sauberer, dokumentenähnlicher Textstil. |
|
||||
| `~Text~` | ~~Durchgestrichen~~ | Korrekturen oder erledigte To-Dos. |
|
||||
| `=Text=` | <mark>Highlight</mark> | Textmarker-Effekt für wichtige Schlüsselwörter. |
|
||||
| `^Text^` | <sup>Hochgestellt</sup> | Mathematische Notation oder Indizes. |
|
||||
| `°Text°` | <sub>Tiefgestellt</sub> | Chemische Formeln (liegt auf derselben Taste wie `^`!). |
|
||||
| `` `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 & Strukturen (`&-`, `&+`)
|
||||
```text
|
||||
&-
|
||||
Erster Listenpunkt
|
||||
Zweiter Listenpunkt
|
||||
&
|
||||
|
||||
```
|
||||
|
||||
*Ergebnis: Unsortierte Aufzählung (Bullet Points).*
|
||||
|
||||
```text
|
||||
&+
|
||||
Erster nummerierter Punkt
|
||||
Zweiter nummerierter Punkt
|
||||
&
|
||||
|
||||
```
|
||||
|
||||
*Ergebnis: Nummerierte Liste (1., 2., ...).*
|
||||
|
||||
### Kompakte Block-Übersicht (`&c`, `&q`, `&b`, `&f`)
|
||||
|
||||
| Block-Typ | Kurzbeschreibung & Syntax-Beispiel |
|
||||
| --- | --- |
|
||||
| **Code (`&c`)** | `&c python` <br>
|
||||
|
||||
<br> `print("Fluss-Formatierungen werden hier ignoriert")` <br>
|
||||
|
||||
<br> `&` |
|
||||
| **Zitat (`&q`)** | `&q` <br>
|
||||
|
||||
<br> „Dies ist ein eigenständiger **Zitatblock** (Blockquote).“ <br>
|
||||
|
||||
<br> `&` |
|
||||
| **Bibeltext (`&b`)** | `&b` <br>
|
||||
|
||||
<br> „Ein spezialisierter Textblock für Bibelstellen und Quelltexte.“ <br>
|
||||
|
||||
<br> `&` |
|
||||
| **Spoiler / Fold (`&f`)** | `&f Klickbarer Titel des Spoilers` <br>
|
||||
|
||||
<br> Hier steht der standardmäßig versteckte Inhalt (HTML `<details>`). <br>
|
||||
|
||||
<br> `&` |
|
||||
|
||||
### Tabellen & Galerien (`&t`)
|
||||
|
||||
Tabellen definieren ihre Spaltenanzahl (`3x` = 3 gleiche Spalten) oder manuelle Breiten (`20% 80%`) in der Startzeile. Die erste Zeile wird durch `` automatisch als Tabellenkopf deklariert.
|
||||
|
||||
```text
|
||||
&t 3x
|
||||
**Name** | **Beruf** | **Stadt**
|
||||
Simon | Entwickler | Zürich
|
||||
&
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Links, Medien & Fußnoten
|
||||
|
||||
### Links & Medien
|
||||
|
||||
* `[Codeberg](URL)` → Standard-Link (selber Tab)
|
||||
* `[Codeberg]{URL}` → Komfort-Link (neuer Tab / `target="_blank"`)
|
||||
* `` → Standard-Bild
|
||||
* `` → Bild mit definierter Breite (Höhe skaliert automatisch)
|
||||
|
||||
### Bildergalerien (Kombination aus `&t` und `![...]`)
|
||||
|
||||
```text
|
||||
&t 3x
|
||||
 |  | 
|
||||
|Abbildung 1: Alpen| |Abbildung 2: Italien| |Abbildung 3: Schwarzwald|
|
||||
&
|
||||
|
||||
```
|
||||
|
||||
### Fußnoten
|
||||
|
||||
* `^1[Hier steht der Fußnotentext]^` → Manuelle Nummerierung (Fußnote 1)
|
||||
* `^x[Hier steht der Fußnotentext]^` → Automatische, fortlaufende Nummerierung durch SimonUp
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue