Зачем это нужно
Мы предоставляем ориентированное на документацию приложение, демонстрирующее, что управляемый CMS контент можно превратить в отточенный сайт документации без переработки слоя отображения.
Используйте это, когда
- размещаете документацию продукта поверх контента CMS
- отображаете документы с большим количеством Markdown
- создаете навигацию по документации с боковой панелью и поиском
Что входит
- приложение docs-template на Next.js
- отрисовка catch-all маршрута на базе CMS
- граница Markdown для документации
- специализированные для документации компоненты навбара, боковой панели и контента
- загрузка записей и категорий с учетом языка
Основной рабочий процесс
- Настройте приложение документации с переменными окружения CMS.
- Отрисовывайте маршруты документации через
cms-renderer. - Получайте документы категорий и записей из схем CMS.
- Отрисовывайте контент Markdown с помощью компонентов, ориентированных на документацию.
- Дополняйте его расширенной навигацией и поиском.
Области системы
- слой маршрутов приложения документации
- слой UI-компонентов документации
- вспомогательные средства CMS для данных и URL документации