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