Откройте файл .md или .markdown в Elide, чтобы прочитать его как отформатированный
документ в терминале. Так удобно читать README репозитория, эксплуатационный ранбук по SSH или заметки разработчика, не
выходя из оболочки. Проект Elide не требуется.
Чтение README или ранбука
elide README.md
elide docs/runbook.md
elide run notes.markdown
Заголовки задают визуальную иерархию; списки, цитаты, таблицы и панели кода упрощают просмотр длинных документов. Текст переносится по ширине терминала, а для распознанных языков в огороженных блоках кода включается подсветка синтаксиса. Блоки кода отображаются, но не выполняются.
Поддерживается синтаксис CommonMark, а также таблицы, зачёркивание и списки задач в стиле GitHub. Например, сохраните
это как 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 |
Затем выполните elide runbook.md. Ссылки сохраняют свои адреса, а сырой HTML отображается как текст.
Пролистывание длинного документа
Elide выводит отрисованный документ в stdout. Чтобы прокручивать его, передайте вывод в пейджер, например less:
elide docs/runbook.md | less
Перенаправленный вывод по умолчанию не содержит оформления. Чтобы сохранить цвета терминала в пейджере, понимающем ANSI-последовательности:
elide --color docs/runbook.md | less -R
--no-color и переменная окружения NO_COLOR имеют приоритет над принудительным цветом. Если NO_COLOR задана,
уберите её из окружения перед запуском примера с цветом.
Сохранение читаемой текстовой копии
Явно отключайте цвета, когда сохраняете отрисованные заметки в лог или артефакт:
elide --no-color notes.markdown > notes.txt
Так записывается терминальное представление вместе с разметкой, а не Markdown, преобразованный в другой формат
документа. Исходный файл не меняется. --quiet тоже сохраняет отрисованный вывод.
--format предназначен для вывода Pkl и PCF и отклоняется для файлов Markdown. Отрисовка
документов также отклоняет --sandbox и --limit. Параметры команды см. в справочнике CLI.