Skip to content

articles.md

Latest commit

 

History

History
79 lines (55 loc) · 5.96 KB

articles.md

File metadata and controls

79 lines (55 loc) · 5.96 KB

Редактирование статей

Содержимое папки content/[locale]/articles автоматически формирует список статей на сайте:

Вы можете добавить статью на сайт или ссылку на статью на стороннем ресурсе.

Общие принципы

  1. Создаёте md-файл в папке нужного языка/articles
  2. Рядом с md-файлом делаете одноимённую папку и в неё складываете картинки.
  3. Путь к картинке указываете относительный, то есть без косой черты в начале.

Статьи разбиваются на категории, доступные смотрите в файле /common/article_categories.ts. Здесь же можно их добавить или переименовать.

Как добавить статью

Перейдите в папку нужного языка:

Создайте пустой md-файл и рядом с таким же названием папку под картинки, например:

  • content/ru/articles/my_article.md — файл с будущим текстом.
  • content/ru/articles/my_article — папка под картинки. Сюда сложите картинки весом не больше 3 Мбайт каждая. Ограничений на разрешение картинок нет — движок сам обработает их в нужный размер. Формат картинок может быть jpg, webp, png, выбирайте удобный для вашей задачи.

Путь к картинкам указывать относительный, то есть без косой черты в начале, пример: my_article/my_article.jpg. Для названий .md-файлов и картинок использовать латиницу. Не использовать пробелы (заменять на подчёркивание _), тире, скобки, решётки и другие специальные символы.

Ниже шаблон md-файла:

---
title: Заголовок (чем лаконичнее, тем лучше)
cover: Путь до обложки внутри папки рядом с md-файлом (например my_article/my_article.jpg)
date: Дата публикации в формате ISO 8601 (YYYY-MM-DD, например 2023-01-21), будет отображаться в конце страницы
category: Категория (например educational, список доступных категорий смотрите в общих принципах)
author: Опциональное поле для статей опубликованных на нашем сайте (например Михаил Первенцев), если оставить пустым то будет отображаться надпись «Команда Wiren Board»
---

## Подзаголовок статьи № 1

Тут текст.

### ПодПодзаголовок

И так далее...

Обратите внимание, что при использовании заголовков следует начинать с заголовка второго уровня (##) и далее, так как заголовок первого уровня будет автоматически сформирован из содержимого поля title.

В тексте можно использовать компоненты.

Как добавить ссылку на внешний ресурс

Если интересная статья опубликована на внешнем ресурсе, можно добавить ссылку.

Делаете всё, что при добавлении статьи, только md-файл у вас будет такой:

---
title: Заголовок (чем лаконичнее, тем лучше)
url: Ссылка на страницу со статьёй
cover: Путь до обложки внутри папки рядом с md-файлом (например my_article/my_article.jpg)
date: Дата публикации в формате ISO 8601 (YYYY-MM-DD, например 2023-01-21)
category: Категория (например educational, список доступных категорий смотрите в общих принципах)
---

Предпросмотр

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

Если вы редактируете и запускаете сайт локально на компьютере, вот ссылки для предпросмотра:

Изменения станут доступны для всех пользователей после отправки пуллреквеста и вливания утверждённых изменений.