Редактирование контента minter.network

Весь контент на minter.network представлен в виде Markdown файлов с расширением .md в репозитории github.com/MinterTeam/minter-network-web.

Для редактирования контента нужно форкнуть репозиторий. Внести изменения в своём форке, сделать это можно либо в редакторе в интерфейсе Github, либо клонировать репозиторий и локально использовать любимый редактор, а затем запушить обратно в репозиторий. Затем нужно сделать pull request обратно в исходный репозиторий для слияния ваших изменений. Когда ваши файлы попадут в ветку master, они автоматически будут залиты на сайт minter.network.

Структура директорий

Файлы должны располагаться в директории /content и разбиты по категориям:

  • /content/docs - документация по особенностям работы блокчейна Minter, его API и SDK
  • /content/howto - инструкции и статьи по реализации конкретных задач, например, "Как написать телеграм бота"
  • /content/earn - всё про заработок в Minter

Такие файлы будут автоматически превращены в html страницы. Адрес страницы будется основываться на пути файла, отбрасывая начальный /content и завершающие .md или index.md части, например:

ФайлURL
/content/docs/index.md/docs
/content/docs/second.md/docs/second
/content/ru/howto/third.md/ru/howto/third

Изображения

Изображения должны располагаться в папке /assets/img.

Путь до изображения должен соответствовать расположению статьи. Например, для статьи /content/ru/docs/second.md изображение должно лежать по пути /assets/img/docs/second/my-image.jpg. Локаль не указывается в пути картинки, т.к. в большинстве случаев изображение будет одно для всех локалей. Если же нужно несколько версий картинки под каждую локаль, то можно добавить суффикс в название файла: my-image.jpg, my-image-ru.jpg.

На сайте они будут доступны по тому же адресу, только без префикса /assets. Так что использовать эту картинку нужно будет тоже без /assets:
![My image](/img/docs/second/my-image.jpg)

Ширина контента на сайте: 640px, значит изображения должны быть шириной 1280px, чтобы они хорошо смотрелись на retina экранах. Конечно, это только в случае, если нужно использовать изображение занимающее всю ширину. Для маленьких инлайновых изображений нужно задавать реальную ширину, а не x2.

Markdown разметка

Помимо базового синтаксиса поддерживается расширенный набор возможностей: GitHub Flavored Markdown (GFM)

Влияние содержимого файла на боковое меню

Заголовок первого уровня будет использован в боковом меню, для навигации по категории (например, по категории /docs).

# Заголовок 1

Заголовки второго уровня будут отображены в боковом меню для удобной навигации по текущей странице. 

## Заголовок 2

## Ещё один заголовок 2

Metadata

Поддерживается Front Matter формат для указания параметров страницы.

Фронтматтер блок должен:

  • быть первым в файле,
  • содержать YAML данные,
  • быть окружён тремя дефисами с начала и с конца.
---
order: 5
title: Blogging Like a Hacker
description: Short page description for SEO
---

Поддерживаются следующие переменные:

  • order: порядок страницы в боковом меню, если не задан, то по-умолчанию будет использоваться значение 100, для index.md файла будет использовано значение 0.
    Т. е. index.md страница всегда будет первой,
    страницы со значением 1-99 будут стоять выше страниц без order,
    страницы со значением 100+ будет стоять ниже страниц без order
  • title: можно переопределить название используемое в боковом меню, так же используется в meta тэгах для SEO
  • description: используется в meta тэгах для SEO