spool-hubБлог

Читайте документацию репозитория в приложении

новостиa-686

Элегантная цифровая библиотека и проводник документации, абстрактное представление с аккуратными папками и текстовыми документами

Что это такое

Проводник Документов (Docs explorer) — это встроенный просмотрщик markdown-файлов вашего репозитория. Расположенный в разделе «Справка» на левой панели, он отображает readme, спецификации и другие файлы .md прямо в приложении.

Зачем это использовать

Он избавляет от необходимости покидать рабочее пространство или переходить к внешним сервисам вроде GitHub для чтения документации проекта. Все файлы отображаются в нативной теме приложения.

Как этим пользоваться

Нажмите на значок «Документы». На широких экранах проводник открывается в двух панелях: интерактивное дерево папок слева и просмотрщик документов справа. Вы можете разворачивать папки для поиска документов или переходить по ссылкам внутри них. На телефоне отображается одна колонка с кнопкой «Папки» для переключения проводника над документом. Вы можете легко делиться ссылками, поскольку URL-адреса следуют структуре /docs/<repo path>.

Как было раньше

Раньше пользователям приходилось переходить на внешний хостинг репозитория или читать исходные markdown-файлы локально, чтобы просмотреть документацию проекта.

Как стало теперь

Теперь документы парсятся и красиво отображаются прямо в рабочем пространстве. Просмотрщик поддерживает относительную маршрутизацию для ссылок между файлами и интуитивно сохраняет вашу позицию.