Hyperbook
Hyperbook ist eine schnelle und einfache Möglichkeit interaktive Arbeitshefte zu erstellen, die moderne Standards unterstützen und sehr schnell sind. Dazu werden Markdown-Datein in statische HTML-Seiten umgewandelt.
Du brauchst keine Programmiererfahrung. Du brauchst nur Markdown-Dateien erstellen und editieren.
Los Gehts
Du kannst mit der Erstellung deines Hyperbook auf drei Arten starten. Wähle die Art die am besten zu dir passt.
- Installiere VS Code oder VS Codium
- Installiere die Hyperbook Erweiterung für VS Code oder VS Codium
- Downloade den hyperbook-anywhere Starter
- Entpacke die Datei
- Öffne den Order in VS Code
- Führe den Befehl
Hyperbook: Show side previewaus
Du benötigst Node version 16 oder höherer auf deinem System.
- Führe
npx hyperbook new my-new-hyperbookaus und folge den Anweisungen, um dein erstes Hyperbook zu erstellen. - Führe
npx hyperbook devaus, um den Entwicklungsserver zu starten. - Besuche https://localhost:3000 mit deinem Lieblingsbrowser.
- Modifiziere oder füge neue Seiten zu deinen Hyperbook hinzu mit deinem Lieblingseditor.
Die meisten Platformen für kollaborative Versionskontrolle haben eine integrierte Web IDE, wie GitLab oder GitHub.
Du kannst eins der Startprojekte forken und direkt loslegen:
- GitHub: https://github.com/mikebarkmin/hyperbook-github-pages/fork
- GitLab: https://gitlab.com/mikebarkmin/hyperbook-gitlab-pages/-/forks/new
- EduGit: https://edugit.org/mikebarkmin/hyperbook-edugit-pages/-/forks/new
Wenn du diesen Ansatz wählt, wirst du keine repräsentative Vorschau bekommen. In den meisten Fällen bekommst du nur eine normale Markdown-Vorschau, welche manche Features von Hyperbook nicht unterstützt.
Bereitstellen
Das Hauptziel des Schreibens eines Hyperbooks ist ein interaktives Arbeitsheft. Dafür muss diese auf einen Server bereitgestellt werden.
Zum Glück sind GitHub Pages, GitLab Pages und Vercel kostenlose Optionen, welche bereits für dich konfiguriert sind, wenn du unseren Starter benutzt hast hyperbook-anywhere.
Du musst die Dateien nur zu GitHub, GitLab oder EduGit pushen.
Wenn du die CLI Version verwendet hast, kannst du außerdem dein Hyperbook in statische HTML-Dateien umwandeln, welche du überall hochladen kannst. Dafür musst du den folgenden Befehl ausführen:
npx hyperbook buildDanach kannst du die Dateien vom Ordner .hyperbook/out zum Zielort kopieren.
Vergiss nicht den basePath in deiner hyperbook.json zu setzen.
Update
Updates sollten automatisch funktionieren.
Um die neuste Version des Hyperbook CLI zu bekommen, benutzte den folgenden Befehl:
npm update hyperbook --globalKeine Integration und daher auch keine Updates.
Unterstützung
Wir freuen uns von dir zu hören, wenn du Unterstützung oder neue Features für deinen Anwendungszweck benötigst.
Du kannst außerdem unserem Matrix Channel beitreten oder uns auf Twitter folgen.
Hyperbook is maintained by OpenPatch, an organization for educational assessments and training. If you need help or create a Hyperbook get in touch.