Öffnen Sie eine .md- oder .markdown-Datei mit Elide, um sie als formatiertes Terminal-Dokument zu
lesen. Nutzen Sie das für die README eines Repositorys, ein Betriebs-Runbook über SSH oder Entwicklungsnotizen, ohne die
Shell zu verlassen. Ein Elide-Projekt ist nicht erforderlich.
Eine README oder ein Runbook lesen
elide README.md
elide docs/runbook.md
elide run notes.markdown
Überschriften schaffen eine visuelle Hierarchie; Listen, Zitate, Tabellen und Code-Panels machen längere Dokumente leichter überfliegbar. Fließtext wird auf die Terminalbreite umbrochen, und umzäunte Codeblöcke erhalten Syntaxhervorhebung für erkannte Sprachen. Codeblöcke werden angezeigt, nicht ausgeführt.
Unterstützt wird CommonMark-Syntax samt Tabellen, Durchstreichung und Aufgabenlisten im GitHub-Stil. Speichern Sie zum
Beispiel dies als runbook.md:
# Check the service
- [x] Generate configuration
- [ ] Verify the health endpoint
```shell
curl http://localhost:8080/health
```
| Response | Next step |
| --- | --- |
| 200 | Continue deployment |
| 503 | Check application logs |
Führen Sie dann elide runbook.md aus. Links behalten ihre Ziele, und rohes HTML wird als Text angezeigt.
Durch ein langes Dokument blättern
Elide gibt das gerenderte Dokument auf stdout aus. Leiten Sie es an einen Pager wie less weiter, wenn Sie scrollen
möchten:
elide docs/runbook.md | less
Weitergeleitete Ausgabe ist standardmäßig schlicht. Um Terminalfarben mit einem Pager zu behalten, der ANSI-Escapes versteht:
elide --color docs/runbook.md | less -R
--no-color und die Umgebungsvariable NO_COLOR haben Vorrang vor erzwungener Farbe. Ist NO_COLOR gesetzt,
entfernen Sie sie aus der Umgebung, bevor Sie das Farbbeispiel verwenden.
Eine lesbare Textkopie speichern
Schalten Sie Farben ausdrücklich ab, wenn Sie gerenderte Notizen für ein Log oder ein Artefakt speichern:
elide --no-color notes.markdown > notes.txt
Das schreibt die Terminal-Darstellung samt Layout, statt Markdown in ein anderes Dokumentformat umzuwandeln. Die
Quelldatei bleibt unverändert. Auch --quiet erhält die gerenderte Ausgabe.
--format ist für Pkl- und PCF-Ausgabe gedacht und wird für Markdown-Dateien abgelehnt. Die
Dokumentdarstellung lehnt außerdem --sandbox und --limit ab. Befehlsoptionen finden Sie in der
CLI-Referenz.