From b2e82fccd661f6f6fd1a53dd45c3a96054456e5c Mon Sep 17 00:00:00 2001 From: MultisampledNight Date: Sun, 25 Feb 2024 22:49:45 +0100 Subject: [PATCH] feat: add first 2 lessons --- .gitignore | 1 + 01-install/lesson.typ | 39 ++++++++++++++++++++++++++++++++++ 02-styling/lesson.typ | 49 +++++++++++++++++++++++++++++++++++++++++++ 03-modes/lesson.typ | 0 README.md | 3 +-- 5 files changed, 90 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 01-install/lesson.typ create mode 100644 02-styling/lesson.typ create mode 100644 03-modes/lesson.typ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a136337 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.pdf diff --git a/01-install/lesson.typ b/01-install/lesson.typ new file mode 100644 index 0000000..bbacf16 --- /dev/null +++ b/01-install/lesson.typ @@ -0,0 +1,39 @@ += Installation + +Primär gibt es 3 Wege, um Typst zu verwenden: + ++ Webapp von Typst selber, + welche man unter https://typst.app/ auch gleich erreichen kann. + Benötigt allerdings Login. + ++ Texteditor deiner Wahl. + Typst hat ein #link("https://github.com/typst/typst")[Open-Source CLI], + aber je nach Editor kann das mehr oder weniger aufwendig aufzusetzen sein, + wenn man noch Hot Reloading und in die Richtung haben möchte. + + - Netterweise hat das CLI auch den Befehl `typst watch`, + was die gegebene typst-Datei bei jeder gespeicherten Änderung + neu zu einem PDF kompiliert. + ++ Einen dezidierten Editor für Typst. + + - Derzeit ist uns nur #link("https://github.com/Cubxity/typstudio")[typstudio] bekannt. + +== CLI + +In Arch, Nixpkgs, SUSE, Void und macOS durch Homebrew ist typst schon packaged. +Ansonsten kann man sich die Assets +#link("https://github.com/typst/typst/releases/tag/v0.10.0")[vom letzten Release auf GitHub] +holen. + += Aufgabe + +Kompiliere dieses Dokument hier +und zeige es in einem PDF-Viewer deiner Wahl an. +Mit dem CLI sollte das mithilfe von `typst compile` gehen. + += Nächste Lesson... + +Schauen wir uns an, +wie wir zum Beispiel die Links hier im Dokument +etwas aufhübschen und vom eigentlichen Text unterscheidbar können. diff --git a/02-styling/lesson.typ b/02-styling/lesson.typ new file mode 100644 index 0000000..9953250 --- /dev/null +++ b/02-styling/lesson.typ @@ -0,0 +1,49 @@ += Styling + +Jetzt, wo wir Dokumente auch komplieren können, +wollen wir doch mal sehen, +was diese so enthalten können. + +Generell ist die Syntax sehr ähnlich zu Markdown, +die wichtigsten Unterschiede sind: + +== Nummerierte Listen + ++ Nummerierte Listen können auch mit `+` anstatt von expliziter Eintragsnummer +2. wie hier ++ gemacht werden. Beides ist äquivalent. + +== Überschriften + +Gehen mit `=` anstatt von `#`. + +== Hervorhebung + +Gibt es mit einmal `_` für _kursiv_ +und einmal `*` für *fettgedruckt*. +Das ist auch _*kombinierbar*_. + +== Links + +Wie https://example.com/ sind zwar automatisch im PDF anklickbar, +aber werden farblich per default nicht unterschieden. + +Das lässt sich allerdings mithilfe einer _show-rule_ ändern. + +#show link: underline + +Nach dieser show-rule sind alle Links, +direkt wie https://example.com/ +oder indirekt wie #link("https://example.com")[der hier] +unterstrichen. + +Show-rules und ihre Freunde set-rules ändern alles, was danach steht. + += Aufgabe + +Nimm eine beliebige Markdown README aus einem beliebigen geklonten Git Repo +und schreib diese in typst um. + += Nächste Lesson... + +Schauen wir uns an, was `#` überhaupt soll. diff --git a/03-modes/lesson.typ b/03-modes/lesson.typ new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index eb62e39..948900e 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,10 @@ und direkt im Anschluss eine Aufgabe, die zum Experimentieren mit diesem Konzept einlädt. - [Installation](./01-install) -- [Basic markup](./02-markup) +- [Styling](./02-styling) - [Die drei Modi](./03-modes) - [Code mode](./04-code) - [Mathematik](./05-math) -- [Styling](./06-styling) [EH21]: https://eh21.easterhegg.eu/ [typst]: https://typst.app