Создание нескольких документов с помощью Docusaurus

Docusaurus — это фреймворк с открытым исходным кодом, разработанный Facebook и основанный на react. Он позволяет создавать чистую, версионируемую и многоязычную документацию с очень небольшой конфигурацией.

Создайте свой проект

Инициализируйте ваш проект с помощью следующей команды:

npx @docusaurus/init@latest init my-website classic --typescript
Войти в полноэкранный режим Выйти из полноэкранного режима

Затем вы можете запустить режим разработки.

cd my-websiteyarn start
Войти в полноэкранный режим Выйти из полноэкранного режима

Структура проекта

По той же философии, что и Jekyll, вы сможете создать статический сайт на основе markdown-файлов, но вы также можете создавать страницы непосредственно в jsx.

Файл docs Файл docs содержит все главы вашей документации. Мы рассмотрим, как настроить его для создания двух разных документаций.

Создание второй документации

Конфигурация Docusaurus

Мы хотим создать две документации, одну Guide и другую Api. Мы добавим элемент в конфигурацию navbar.

navbar: {
 {
  type: 'doc',
  docId: 'guide/intro',
  position: 'left',
  label: 'Docs',
 },
 {
  type: 'doc',
  docId: 'api/intro',
  position: 'left',
  label: 'Api',
 },
}
Вход в полноэкранный режим Выход из полноэкранного режима

Боковые панели

Мы изменим сайдбары, чтобы включить в них две документации и установить их dirName во вложенные папки, которые мы создадим в папке docs.

module.exports = {
    docSidebar: [{ type: 'autogenerated', dirName: 'guide' }],
    apiSidebar: [{ type: 'autogenerated', dirName: 'api' }],
};
Вход в полноэкранный режим Выход из полноэкранного режима

Написание документации

Теперь вам нужно создать две папки docs/guide и docs/api, в которых вы сможете создать две ваши документации.

Оцените статью
devanswers.ru
Добавить комментарий