README и документация проекта

Joppa показывает документацию, которая есть в проекте: его README.md, другие файлы .md в корне и файлы из папки docs/. Всё отображается в отформатированном виде, только для чтения: как установить проект, запустить его, развернуть — без открытия редактора.

Открыть документацию

Если в проекте есть хотя бы один такой файл, в заголовке проекта рядом с Открыть появляется кнопка: README, если он есть в проекте, иначе Документация. M делает то же самое. Панель также открывается:

• из меню … проекта (Открыть документацию);
• из палитры ⌘ K;
• по подсказке Читать в верхней части вкладок Процессы и Сервисы.

Панель открывается справа поверх текущей вкладки, которой можно продолжать пользоваться, и оставляет терминал видимым внизу. Esc, крестик или M закрывают её. При повторном открытии последний прочитанный файл на месте.

Потяните левый край панели, чтобы расширить или сузить её: Joppa запоминает ширину, а двойной щелчок по краю возвращает её к значению по умолчанию. Когда панель узкая, список файлов превращается в меню над текстом.

Что читает Joppa

Группа	Файлы
Первым	README.md в любом регистре (readme.md, Readme.md…), открывается первым
Корень	остальные .md в корне: CONTRIBUTING.md, DEPLOY.md, CHANGELOG.md…
docs/	файлы .md из папки docs/ (или doc/) и её подпапок, не глубже 4 уровней, не больше 50 файлов
Для агентов	AGENTS.md, CLAUDE.md и GEMINI.md, написанные для агентов кода, но часто полезные (команды тестов, сборки), в конце

Скрытые папки и папки зависимостей (node_modules, vendor, target, dist, build) пропускаются, и ничего не читается за пределами корня и docs/. Список перечитывается при каждом открытии панели; если файл больше 512 КБ, его конец обрезается.

Чтение

Список файлов находится слева; под открытым файлом его заголовки второго и третьего уровня (если их хотя бы три) ведут к каждому разделу. Поддерживается Markdown GitHub: заголовки, списки, таблицы, флажки, цитаты, блоки кода.

• Ссылка на другой файл документации (docs/deploy.md, runbook.md#rollback) открывает его в панели, на нужном разделе.
• Ссылка на веб-страницу открывается в браузере; ссылка на другой файл проекта открывает его в соответствующем приложении.
• Изображения из интернета отображаются; изображения из папки проекта заменяются их альтернативным текстом.
• Открыть файл в верхней части панели открывает показанный файл в его приложении, чтобы его изменить.

Копирование и запуск блока

У каждого блока кода есть кнопка Копировать.

У блоков, помеченных как команды (```bash, sh, shell, zsh, console, terminal или fish), есть также кнопка Запустить — с Joppa Pro. Она выполняет блок в папке проекта, как окно Выполнить команду во вкладке «Скрипты»: строки объединяются через && и останавливаются на первой, завершившейся с ошибкой, а $ в начале строки и комментарии убираются. Вывод попадает во вкладку scripts терминала.

В бесплатной версии документацию можно читать, а её блоки — копировать; на кнопке Запустить стоит пометка Pro.