Translate

Site Preparation

Установив Docusaurus, вы получили основу для работы над вашим конкретным сайтом. Далее обсуждается остальная часть структуры Docusaurus в рамках подготовки вашего сайта к запуску.

Структура каталогов

Как было показано после установки Docusaurus, сценарий инициализации создал примерно такую структуру каталогов:

root-directory
├── .gitignore
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Описание каталогов

• Исходные файлы документации: Каталог docs содержит образцы файлов документации в формате Markdown.
• Блог: Каталог website/blog содержит образцы сообщений блога в формате markdown.
• Страницы: Каталог website/pages содержит образцы высокоуровневых страниц для сайта.
• Статические файлы и изображения: Каталог website/static содержит статические ресурсы, используемые в образце сайта.

Ключевые файлы

• Футер: Файл website/core/Footer.js является компонентом React, который выступает в качестве футера генерируемого сайта и должен быть настроен пользователем.
• Файл настроек: Файл website/siteConfig.js является основным файлом настроек, используемых Docusaurus.
• Боковые панели: Файл sidebars.json отражает структуру и порядок файлов документации.
• .gitignore: Файл .gitignore содержит перечисление файлов, которые не должны быть добавлены в git-репозиторий.

Подготовка

Вам следует сохранить файлы website/siteConfig.js и website/core/Footer.js в составе проекта, но вы можете отредактировать их по своему желанию. Значение поля customDocsPath в website/siteConfig.js может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог website также может быть переименован во что угодно при необходимости.

Тем не менее, вам следует сохранить каталоги website/pages и website/static. Вы можете изменить их содержимое по своему желанию. Также вам как минимум следует иметь файл en/index.js или en/index.html внутри каталога website/pages и изображение, используемое как иконка-значок в шапке вашего сайта в каталоге website/static.

Если ваш каталог еще не содержит .gitignore, мы создадим его самостоятельно со списком всех файлов, которые должны быть проигнорированы. Как правило, вам следует добавлять в .gitignore содержимое node_modules, файлы сборки, системные файлы (.DS_Store), логи и т.п. Здесь вы можете найти наиболее полный список того, что добавляется в ignore-файлы проектов Node.js.