1.13.0

Translate

Adding a Blog

Начальная настройка

Чтобы настроить блог своего сайта, начните с создания каталога blog внутри каталога website в своем репозитории.

Затем добавьте в шапку страницы ссылку на блог, используя файл с настройками siteConfig.js:

headerLinks: [
    ...
    { blog: true, label: 'Blog' },
    ...
]

Добавление сообщений

Чтобы добавить сообщение в блог, создайте в своем каталоге blog файл с именем следующего вида: YYYY-MM-DD-my-blog-post-title.md. Дата добавления сообщения будет извлечена из этого имени.

Например, website/blog/2017-12-14-introducing-docusaurus.md:

---
title: Представляем Docusaurus
author: Джоэл Марси
authorURL: http://twitter.com/JoelMarcey
authorFBID: 611217057
authorTwitter: JoelMarcey
---
Lorem Ipsum...

Настройки заголовка

Единственное обязательное поле это title; однако мы также предоставляем возможность добавить в сообщение информацию об авторе.

  • author - Текстовое обозначение автора, имя.
  • authorURL - URL-адрес, связанный с автором. Это может быть ссылка на учетную запись Twiter, Github, Facebook или что-либо еще.
  • authorFBID - Идентификатор профиля Facebook, который используется для получения изображения-аватара.
  • authorImageURL - URL-адрес к изображению-аватару автора. (Примечание: Если вы используете вместе authorFBID и authorImageURL, то authorFBID будет иметь приоритет. Не указывайте поле authorFBID, если желаете использовать изображение по адресу, указанному в authorImageURL.)
  • title - Заголовок сообщения блога.
  • unlisted - Сообщение будет доступно по прямому URL-адресу, но не будет отображено в боковой панели в конечной сборке; при локальной же разработке сообщение будет отображено. Полезно в ситуациях, когда вам нужно поделиться WIP сообщением с другими людьми для получения их оценки.

Обрезка резюме

Используйте маркер <!--truncate--> в своем сообщении для указания того, какая часть этого сообщения будет отображена в его резюме. Все, что размещено до <!--truncate-->, станет частью резюме. Например:

---
title: Пример обрезки
---

Все это будет частью резюме сообщения в блоге.

И это тоже.

<!--truncate-->

Но вся информация здесь уже нет.

И не это.

Или это.

Определение количества сообщений блога, отображаемых в боковой панели

По-умолчанию, в боковой панели отображаются 5 последних сообщений блога.

Вы можете настроить количество отображаемых сообщений, добавив поле blogSidebarCount в файл siteConfig.js.

Допустимые значения - целое число, определяющее количество сообщений, которые вы хотите показать, или строка со значением 'ALL'.

Например:

blogSidebarCount: 'ALL',

Определение заголовка боковой панели

Вы можете указать заголовок для боковой панели, добавив поле blogSidebarTitle в siteConfig.js.

Это поле представляет собой объект, который может содержать свойства default и all. Указав значение для свойства default вы можете изменить заголовок боковой панели по-умолчанию. Указав значение для all, вы можете изменить заголовок боковой панели, когда значение поля blogSidebarCount равно 'ALL'.

Например:

blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },

RSS-канал

Docusaurus provides an RSS feed for your blog posts. Поддерживаются оба формата - RSS и Atom. Эти данные будут автоматически добавлены в секцию <HEAD> HTML страниц вашего сайта.

Краткий текст сообщения до тега <!--truncate--> отправляется в RSS-канал. Если сообщение не содержит тег <!--truncate-->, то из его текста будут использованы первые 250 символов.

Социальные Кнопки

Если вы желаете добавить кнопки социальных сетей Facebook или Twitter в нижнюю часть сообщений своего блога, установите параметр facebookAppId и/или twitter в настройках сайта в siteConfig.js.

Дополнительные возможности

Я хочу работать в режиме «Только блог».

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

Для этого:

  1. Создайте файл index.html в website/static/.
  2. Перенесите содержимое шаблона ниже в website/static/index.html
  3. Настройте <title> в website/static/index.html
  4. Удалите динамически генерируемую посадочную страницу website/pages/en/index.js

Теперь, когда Docusaurus будет генерировать или строить ваш сайт, он скопирует файл static/index.html и разместит его в главном каталоге вашего сайта. Статический файл будет отдан посетителю, когда он придет на страницу. Когда страница загрузится, посетитель будет перенаправлен на /blog.

Вы можете использовать этот шаблон:

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="refresh" content="0; url=blog/" />
    <script type="text/javascript">
      window.location.href = 'blog/';
    </script>
    <title>Заголовок вашего блога</title>
  </head>
  <body>
    Если ваш брузер не поддерживает автоматическую переадресацию, перейдите по этой ссылке: 
    <a href="blog/">link</a>.
  </body>
</html>
← DockerCustom Pages →