Гайд о гайде: как написать свой туториал и не сесть в лужу¶

Гайды пишутся с помощью разметки Markdown (краткое руководство)

Для начала вам понадобится сделать форк репозитория

После этого можно приступать к основной работе

Краткое описание¶

В файле mkdocs.yml в секции nav в соответствующем севере добавьте строчку вида

- "<имя гайда>": <путь к главной странице гайда>

где <путь к главной странице гайда> - это путь вида <имя сервера>/<имя папки гайда>/index.md, например Technocracy/my_beautiful_guide/index.md, чтобы файл стал выглядеть так:

nav:
  - Главная страница: index.md
    ...
  - Technocracy:
      - "Гайды": Technocracy/index.md
      - "Гайд по гайду от Veritaris": Technocracy/guide_about_guide/index.md

Затем в папке сервера создайте папку с именем вашего гайда (my_beautiful_guide), а в нём файл index.md - это будет его основной файл. Вы можете написать свой гайд как полностью в одном файле, так и разбить его на несколько более мелких - для этого в папке гайда создайте папку с названием раздела, а внутри него так же создайте файл index.md

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

Использование GitHub¶

Более подробно о том, как работать с GitHub в браузере, можно посмотреть здесь

Небольшие заметки для ускорения принятие гайда и сохранения общего стиля:¶

Проверяйте орфографию!
Называйте фотографии своими именами
В названиях файлов заменяйте пробелы нижними подчёркиваниями _
Все фотографии храните в одной папке <имя гайда>/images
Для продвинутых - используйте git lfs, сэкономьте ваше и наше место