quickstart

LiaScript/liascript.md

@@ -0,0 +1,13 @@
+# LiaScript
+
+Kurse des Schulsticks werden in einer **[Markdown](../Markdown/markdown.md)erweiterung** mit dem Name [LiaScript](https://liascript.github.io/) erstellt.
+
+Zum erstellen unseres ersten Tutorials reicht es vollkommen aus, einfaches [Markdown](../Markdown/markdown.md) ohne die zusätzlichen Möglichkeiten von LiaScript zu schreiben.
+
+Wer in seinen Tutorials (später) LiaScript nutzen möchte, kann hier [**Beispiele**](https://liascript.github.io/LiveEditor/examples.html) finden.
+
+Es gibt einen [**Online-Editor**](https://liascript.github.io/LiveEditor/?/show/file/https://raw.githubusercontent.com/LiaScript/docs/master/README.md) mit dem Name LiaEdit, indem nebeneinander die Ausgangsform geschrieben und die Zielform gesehen werden kann. Das verlinkte Beispiel öffnet die offizielle LiaScript-Dokumentation, welche selbst in LiaScript geschrieben ist.
+
+> Hinweis: Im Gegensatz zu Hedgedoc, werden bei LiaEdit die Änderungen nicht sofort in der Zielform angezeigt. Zum Übersetzen muss jedes mal die Tastenkombination **`Strg+s`** gedrückt werden.
+
+> Hinweis: LiaScript zeig nur Inhalte an, wenn sie unterhalb einer **Überschrift** sind.

Markdown/markdown.md

@@ -0,0 +1,11 @@
+# Markdown
+
+[**Markdown**](https://de.wikipedia.org/wiki/Markdown) ist eine leicht zu erlernende Auszeichnungssprache.
+
+Die für den Schulstick erstellten Kurse werden in Markdown oder ihrer Erweiterung [Liascript](../LiaScript/liascript.md) erstellt.
+
+Wer nicht weiß, wie Markdown aussieht, kann sich als [**Beispiel**](https://raw.githubusercontent.com/fsfw-dresden/schulstick-tutorial-docs/refs/heads/main/Markdown/markdown.md) die Datei anschauen, aus der die hier gerade angezeigte Seite erstellt wurde. Wie man sieht, handelt es sich bei Markdown um ein leicht lesbares Textformat, dessen „Ausgangsform“ schon recht ähnlich zur gewünschten „Zielform“ ist.
+
+Markdown zu lernen ist einfach und geht schnell. Die wenigen nötigen Auszeichnugen werden [hier beschrieben](https://de.wikipedia.org/wiki/Markdown#Auszeichnungsbeispiele).
+
+Zum erlernen kann der **Online-Markdown-Editor** [Hedgedoc](https://hedgedoc.c3d2.de/features?both) empfohlen werden. In ihm ist es möglich in Echtzeit nebeneinander die Ausgangsform zu editieren und die darus erstellte Zielform zu sehen. Hedgedoc erlaubt auch das gleichzeitege Editieren durch mehrere Benutzer.

Quickstart/quickstart.md

@@ -3,17 +3,78 @@
 Dieser Quickstart zeigt, wie neue Kurse für den Schulstick erstellt werden.
 
 
-
 ## Markdown
 
-`TODO` knapp erklären, dass „nur“ Markdown benötigt wird
+Kurse für den Schulstick werden in [Markdown](../Markdown/markdown.md) oder der Erweiterung [LiaScript](../LiaScript/liascript.md) erstellt.
+Im folgenden verwenden wir den Editor LiaEdit. Mit ihm können alle unterstützen Funktionen genutzt werden.
+
+Wenn in diesem Schritt etwas nicht funktioniert, kann aber auch jede andere [Markdown-Editor](../Markdown/markdown.md) verwendet werden.
+
+
+## LiaEdit
+
+Wir empfehlen den Editor LiaEdit.
+
+> Als erstes müssen wir den [**Editor über diesen Link öffnen**](https://liascript.github.io/LiveEditor/?/edit)
+
+Es sollte sich ein Browserfenster öffnen, dass etwa so aussieht:
+
+`Todo` Screenshot
+
+Auf der linken Seite ist eine schwarzes Texteingabefeld. Dort hinein werden wir LiaScript oder anderes Markdown schreiben.
+
+Auf der rechten Seite sehen wir zunächst einen kurzen Einführungtext, der die Benutzung des Editors erklärt.
+
+
+### Hallo Welt
+
+Wir wollen jetzt unser erstes LiaScript-Dokument erstellen.
+
+Dafür klicken wir in das schwarze Texteingabefeld und fangen an zu tippen. Als Beispiel verwenden wir folgenes:
+
+```md
+# Mein erster Kurs
+
+Hallo Welt
+```
+
+Die erste Zeile beginnt mit dem Zeichen **`#`**. Zeilen die so anfangen werden in Markdown als Überschrift verstanden.
+
+> Wichtig: LiaScript erwartet, dass unser Dokument mindestens eine Überschrift hat. Nur die Inhalte unterhalb der ersten Überschrift werden angezeigt.
+
+Wir drücken jetzt die Tastenkombination *`Strg + s`*. Wenn auf deiner Tastatur keine Taste mit `Strg` beschriftet ist, dann bestimmt mit `Ctrl`.
+
+Sobald wir gleichzeitig die Tasten `Strg` und `s` gedrückt haben, sollte sich die rechte Hälfte des Fensters ändern und so aussehen:
+
+`Todo` Screenshot
+
+
+### eigene Inhalte
+
+Wir können jetzt beliebig oft etwas ändern und mit `Strg + s` sehen wie LiaScript es darstellt.
+
+Du kannst dich jetzt hier frei ausprobieren. 
+
+> Mehr [Infos zu LiaScript](../LiaScript/liascript.md)
+
+
+## Kurse im Portal auf dem Lernstick einbinden
+
+Um selbstgeschriebenen Markdown-Dateien als Kurs im Portal auf dem Lernstick verfügbar zu machen, mussen wir die erstellte Datei herunterladen und in einem Ordner ablegen, wo das Portal es erwartet.
+
+In LiaEdit klicken wir oben rechts auf „Menu“ und wählen aus dem Abschnitt „Download to“ den Eintrag „README.md“. Indem wir mit Rechtsklick auf „README.md“ klicken, geht ein Kontextmenü des Browsers auf das uns „Speichern unter“ anbietet.
+
+`Todo` Screenshot
+
+Wir legen den neuen Ordner `~/.local/share/learning-portal/courses/draft/mein_quckickstart_tutorial/erste_lektion` an und speichern darin die Markdown-Datei. Der Dateiname ist egal, muss aber auf „.md“ enden.
+
 
-## Liascript
+### Portal neu starten
 
-`TODO` Liascript und die Nutzung des Editors
+Wir können das Portal aus dem Startmenü auswählen und sollten unseren neuen Kurs sehen.
 
-## Tutorials im Portal (auf dem Lernstick) einbinden
+`Todo` Screenshot
 
-.local/share/learning-portal/courses/draft/mein_quckickstart_tutorial/erste_lektion
+Fertig :)
 
-mkdir -p ~/.local/share/learning-portal/courses/draft/mein_quckickstart_tutorial/erste_lektion
+Später werden wir lernen, wie mit zusätzlichen Konfigurationsdateien weitere Funktionen des Portals genutzt werden können.

SUMMARY.md

@@ -4,6 +4,8 @@
 * [Ziele](Ziel/ziel.md)
 * [Claim](Claim/claim.md)
 * [Quickstart](Quickstart/quickstart.md)
-* [Ordnerstruktur](Folders_Sources/folders.md)
 * [Glossar](Glossar/glossar.md)
+* [Markdown](Markdown/markdown.md)
+* [LiaScript](LiaScript/liascript.md)
+* [Ordnerstruktur](Folders_Sources/folders.md)
 * [WIP spec](wip_spec/intro.md)

book.toml

@@ -18,4 +18,4 @@ additional-js =["mermaid.min.js", "mermaid-init.js"]
 warning-policy = "error"
 ## Should we check links on the internet? Enabling this option adds a
 ## non-negligible performance impact
-follow-web-links = true
+#follow-web-links = true

wip_spec/intro.md

@@ -52,23 +52,10 @@ Für fortgeschrittene Anwendungsfälle kann ein Tutorial noch weitere Dateien en
 
 Diese Datei beinhaltet die eigentlichen Inhalte.
 
-Die Datei ist in der Auszeichnungssprache [**Markdown**](https://de.wikipedia.org/wiki/Markdown) geschrieben. 
-
-Wie [unser Beispiel](https://raw.githubusercontent.com/fsfw-dresden/learning-portal/refs/heads/main/OER-materials/examples/schulstick_tutorial/lektion1/intro.md) zeigt, die Datei ein einem leicht lesbaren Textformat (Ausgangsform). Da sie eine maschinenlesbare Struktur hat, kann sie automatisch in eine [schöne Zielform](https://github.com/fsfw-dresden/learning-portal/blob/main/OER-materials/examples/schulstick_tutorial/lektion1/intro.md) übersetzt werden.
-
-Markdown zu lernen ist einfach und geht schnell. Die wenigen nötigen Auszeichnugen werden [hier beschrieben](https://de.wikipedia.org/wiki/Markdown#Auszeichnungsbeispiele).
+Die Datei ist in der Auszeichnungssprache [**Markdown**](../Markdown/markdown.md) geschrieben. 
 
 #### LiaScript
 
-Genau genommen wird für die Schulstick-Tutorials eine Markdownerweiterung mit dem Name [LiaScript](https://liascript.github.io/) verwendet.
-
-Zum erstellen unseres ersten Tutorials reicht es vollkommen aus, einfaches Markdown ohne die zusätzlichen Möglichkeiten von LiaScript zu schreiben.
-
-Wer in seinen Tutorials (später) LiaScript nutzen möchte, kann hier [Beispiele](https://liascript.github.io/LiveEditor/examples.html) finden.
-
-Es gibt einen [Online-Editor](https://liascript.github.io/LiveEditor/?/show/file/https://raw.githubusercontent.com/LiaScript/docs/master/README.md), indem nebeneinander die Ausgangsform geschrieben und die Zielform gesehen werden kann. Das verlinkte Beispiel öffnet die offizielle LiaScript-Dokumentation, welche selbst in LiaScript geschrieben ist.
-
-
 ### metadata.yml
 
 Die in Markdown/LiaScript geschriebene Datei (`intro.md`) ist ausreichend um eine Anleitung unabhängig vom Schulscript zu schreiben.