spool-hubБлог

Читайте документацію репозиторію в застосунку

новиниa-686

Елегантна цифрова бібліотека та провідник документації, абстрактне зображення з акуратними теками та текстовими документами

Що це таке

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

Навіщо використовувати

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

Як цим користуватися

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

Як було раніше

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

Як стало тепер

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