Відкрийте файл .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.