Документация по написанию статей

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

Во всех статьях в самом верху должен быть блок, в котором написано название статьи и её краткое описание (до 150 символов) по шаблону:

Название: Документация по написанию статей

Описание: Гайдлайн по написанию статей, фичи движка, гайды как правильно работать с поддерживаемыми форматами (к примеру MarkDown)

Markdown #

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

Вот отличный гайд по Markdown, актуален даже для тех кто не умеет читать инглиш.

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

Движок обвешан всякими полезными фичами, о них далее...

Shortcodes #

Для вставки специальных элементов страницы, таких как Бадж или спойлер

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

Баджи #

К примеру, чтобы вывести этот бадж я использовал этот код:

{% badge "этот бадж", "other" %}

Параметры:

1. badge — название шорткода, указывает движку какую функцию по обработке параметров далее применять
2. этот бадж — текст, который будет написан на бадже
3. other — название цвета, которого будет этот самый бадж

Все параметры отделены запятой и помещены в кавычки.

Доступные цвета #

danger warning success info other

sd — Специальный цвет, используется для выделения баджа #SD!, не рекомендуется к использованию в других случаях

Спойлер #

Чтобы вывести этот спойлер я использовал этот код

{% spoiler "Какой то текст и картинка котёнка" %}

Милый котёнок

{% image "http://placekitten.com/g/200/300", true %}

{% endspoiler %}

Параметры spoiler:

1. spoiler — название шорткода, указывает движку какую функцию по обработке параметров далее применять.
2. Какой-то текст и картинка котёнка — название спойлера.
3. Контент между тегами spoiler и endspoiler — то что и будет скрыто спойлером
4. {% endspoiler %} — закрывающий тег

Все параметры отделены запятой и помещены в кавычки. Это правило для всех шорткодов

Картинка #

Котёнок

Этот же котёнок, но инлайн:

Чтобы вывести эти картинки я использовал этот код

{% image "http://placekitten.com/g/200/300", false, "Котёнок" %}

Этот же котёнок, но инлайн:

{% image "http://placekitten.com/g/200/300", true %}

Параметры image:

1. image — название шорткода, указывает движку какую функцию по обработке параметров далее применять.
2. "http://placekitten.com/g/200/300" — ссылка на картинку
3. false — параметр inline. Если параметр inline равен true, то он просит движок не оборачивать картинку в спойлер, ибо по умолчанию все картинки оборачиваются
4. "Котёнок" — параметр отвечающий за имя спойлера, игнорируется если картинка имеет параметр inline равный true

Заметки #

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

Хоть сайт и обвешан этими фичами, вам необязательно использовать их. Они удобны чтобы к примеру выделить какое-то очень важное слово с помощью баджей, но это не означает что их прям обязательно использовать. Единственные требования что есть у статей — прописаны выше, документация просто рассказывает, что тут есть и как этим пользоваться