Поддерживает ли Docusaurus переименование выходной папки 'docs'?

Question

В настоящее время я оцениваю использование Docusaurus для создания статического веб-сайта. Сам сайт не ориентирован на документацию, фактически сайт даже не связан с компьютерами или технологиями. Но я, как техник, хочу использовать стратегию публикации с использованием CI и Git для этого веб-сайта.

Docusaurus использует Markdown для своего содержимого страницы (вне пользовательских страниц на основе React). Тем не менее, когда эти страницы Markdown создаются, они все помещаются в папку верхнего уровня на статическом сайте под названием docs, Это наименование папок не совсем соответствует веб-сайту, который я хочу создать.

Существует параметр конфигурации для customDocsPath но это только изменится, когда сборка ищет файлы Markdown, а не путь вывода в созданном содержимом сайта.

Я не являюсь разработчиком React, но, за исключением взлома JavaScript в движке сборки для поиска / замены экземпляров docs, Есть лучший способ сделать это?

Answer 1

В настоящее время мы не поддерживаем другие маршруты, кроме /docs - еще. Есть запрос на удаление, который начался еще в августе, но недавно был вновь возрожден. PR пересматривается и обновляется, чтобы предоставить больше настраиваемых маршрутов.

Answer 2

В docusaurus 2 изменить основную папку документов довольно просто:

• переименовать docs/к whatever/

• добавить следующее в docusaurus.config.js

          presets: [
  [
    '@docusaurus/preset-classic', // should be already there
    {
      docs: {
        path: 'whatever',
        routeBasePath: 'whatever',
  // ...
  

Answer 3

Начиная с Docusaurus 1.6 это теперь реализовано. Запрос на удаление был объединен.

Более подробную информацию об этом можно найти в конфигурации сайта.

Просто добавьте следующее к siteConfig раздел в siteConfig.js:

const siteConfig = {
  title: 'My Awesome Site',
  docsUrl: '',
  // ...
};