1.9.x

Translate

Creating your site

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

После установки и настройки, большая часть работы по созданию основы сайта для вашей документации уже должна быть завершена.

Структура сайта

Структура вашего сайта может выглядеть следующим образом:

root-directory
├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Предполагается, что вы удалили образцы .md файлов, установленные командой инициализации.

Все файлы вашей документации должны представлять собой .md файлы markdown и быть размещены в каталоге docs. Любое сообщение блога должно быть размещено в каталоге blog.

Сообщения блога должны иметь имя вида YYYY-MM-DD-your-file-name.md

Создание основы вашего сайта

Чтобы создать полнофункциональный сайт, вам нужно выполнить всего несколько шагов:

  1. Добавьте документацию в виде .md файлов в каталог /docs, убедитесь что каждый файл имеет надлежащий заголовок. One example header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.

    ---
id: intro
title: Getting Started
---
My new content here..

  2. Добавьте, если необходимо, несколько документов в файл sidebars.json, чтобы ваш сайт отобразил боковую панель, в которой будут размещены ссылки на них.

Если вы не укажите свои документы в файле sidebars.json, то они будут обработаны, но ссылки на них будут доступны только из других документов и перейти на них можно будет только зная их URL.

  1. Чтобы настроить сайт, измените файл website/siteConfig.js, следуя указаниям из комментариев в каталоге docs и в файле website/siteConfig.js.
  2. Создайте любые пользовательские страницы и/или настройте файл website/core/Footer.js, в котором содержится футер вашего сайта.
  3. Разместите ресурсы, такие как изображения, в каталоге website/static/.
  4. Запустите сайт, чтобы увидеть результат изменений.
cd website
yarn run start # или `npm run start`
# перейдите по адресу http://localhost:3000

Особые настройки

Посадочная страница

Если вы желаете разместить свою посадочную страницу прямо среди своей документации, вы можете следать это с помощью переадресации.

  1. Удалите файл index.js из каталога website/pages, если он там есть.
  2. Добавьте пользовательскую статическую страницу index.html в каталог website/static, содержащую следующий код:
<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <meta
      http-equiv="refresh"
      content="0; url=docs/id-of-doc-to-land-on.html"
    />
    <script type="text/javascript">
      window.location.href = 'docs/id-of-doc-to-land-on.html';
    </script>
    <title>Your Site Title Here</title>
  </head>
  <body>
    If you are not redirected automatically, follow this
    <a href="docs/id-of-doc-to-land-on.html">link</a>.
  </body>
</html>

Вы получите идентификатор документа для привязки к его метаданным в формате .md.

Блог без документации

Вы также можете использовать Docusaurus чтобы создать блог без документации.

← Site PreparationPublishing your site →