Chrome Dev Summit 2018 is happening now and streaming live on YouTube. Watch now.

Как писать статьи

Это вводный параграф. Это все равно что старый yaml атрибут introduction, но вместо того, чтобы быть в YAML, он теперь находится в документе.

Чтобы написать совершенно новую статью, следуйте этим шагам. Или просто скопируйте этот markdown файл, разместите его в нужной вам директории, и отредактируйте.

YAML Front Matter

Все документы должны иметь минимальный набор YAML front matter включающий ссылку на _project.yaml, и еще одну на _book.yaml.

project_path: /web/_project.yaml
book_path: /web/section/_book.yaml

Описание (необязательный)

Вы можете добавить описание страницы в блоке YAML front matter, которое используется в meta описания страницы. Описание должно быть коротким (<450 символов), и представлять собой лишь краткое описание страницы.

description: Lorem ipsum

Другие YAML атрибуты

Другие атрибуты
full_width: true Передаёт управление разметкой области ниже заголовка и панели проекта и выше футера. Не поддерживается в development окружении.
hide_last_updated: true Скрывает автоматически сгенерированное поле последних обновлений внизу страницы. Не поддерживается в development окружении.

Заголовок страницы (обязательный)

Заголовок страницы определяется первым H1-подобным тэгом с классом .page-title. Например:

# Writing an Article {: .page-title }

Автор и переводчик

Чтобы добавить автора и переводчика используйте:

{% include "web/_shared/contributors/petelepage.html" %}

Написать свой контент

Теперь пришло время добавить ваш контент. Подробные сведения о стилях, которые вы можете использовать смотрите в руководство по стилю письма и руководство по markdown синтаксису. А так же о том как сделать, чтобы все выглядело красиво.

Добавить статью в меню

Чтобы ваша статья появилась в соответствующем блоке навигации нужно обновить _book.yaml или _toc.yaml. Каждый раздел (обновления, демо, основы), имеет их собственный _book.yaml, а также связан с индивидуальным _toc.yaml. Вы, скорее всего, захотите добавить свою статью в один из _toc.yaml.

Испытайте и отправьте свой PR

Когда будете готовы, запустите gulp test, чтобы убедиться, что нет проблем с вашим контентом, а затем посылайте ваш pull request.

Translated by