Laradocs — це Laravel-пакет, який дозволяє створювати сайт документації з Markdown-файлів, що зберігаються безпосередньо у вашій кодовій базі. Документація пишеться поряд з кодом, комітиться разом з ним, а Laradocs відображає її за адресою /docs з автоматичною навігацією, SEO-метаданими та сучасним інтерфейсом.
Основні можливості
Пакет підтримує багаторівневу структуру файлів — вкладені папки автоматично перетворюються на вкладену навігацію. Маршрутизація базується на іменах файлів, але можна перевизначити URL через поле slug у front-matter метаданих. Markdown конвертується в HTML за допомогою CommonMark з підтримкою GitHub-flavored markdown, таблиць, виносок та callout-блоків.
Кожна сторінка може містити метадані в YAML front-matter: title, description, order, hidden, group, badge, redirect, tags та slug. Laradocs пропонує готовий адаптивний UI з темною темою, бічною панеллю, хлібними крихтами, змістом сторінки та навігацією між сторінками.
Додаткові інструменти
Пакет підтримує змінні та макроси для повторного використання контенту, автоматично генерує meta-теги, Open Graph, Twitter Cards та JSON-LD для SEO, а також створює sitemap. Laradocs кешує відрендерені сторінки і автоматично інвалідує кеш при зміні файлів. Є команди для попереднього рендерингу всіх сторінок (laradocs:cache) та очищення кешу (laradocs:clear).
Пакет вимагає PHP 8.2+ і підтримує Laravel 11, 12 та 13. Детальніше можна дізнатися на офіційному сайті Laradocs або переглянути код на GitHub.