Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title Code of Conduct

Добро пожаловать на вики! Для создания удобной и структурированной вики есть следующие правила оформления статей:

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

  • Название статьи должно быть написано с использованием frontmatter:
---
title: Название статьи
---

^notenaming

  • Статьи должны быть хорошо структурированными и легко читаемыми.
  • Используйте заголовки, списки и таблицы для организации информации.
  • Старайтесь сохранять единый стиль оформления по всей вики.
  • Если вы написали или дополнили статью и понимаете, что ее стоит разделить на несколько статей, но вы пока не можете этого сделать, оставьте в начале статьи тег >[!atomization-needed]

Примерно так он будет выглядеть:

[!atomization-needed]

2. Соглашение об именах

  • Все названия файлов, папок, картинок и т.д должны быть написаны в стиле kebab-case.
    • Всё с маленькой буквы.
    • Слова разделены символом тире (-).

3. Оформление текста

  • Используйте заголовки # вплоть до ######, если в этом есть острая необходимость.
  • Используйте маркеры - для списков и нумерацию `1. для упорядоченных списков.
  • Вставляйте ссылки на связанные статьи ([[another-note-name|вид ссылки в тексте]]), чтобы улучшить навигацию по вики.
  • Вставляйте ссылки на внешние ресурсы ([text](https://link.to/resource)), такие как моды, видео, референсы и т.д.

4. Добавление изображений и файлов

  • Используйте изображения при необходимости для иллюстрации материала.
  • Все используемые файлы должны быть помещены в папку files
  • Убедитесь, что файлы оптимизированы по размеру и названы осмысленно ([[#2. Соглашение об именах|см. пункт 2.]]).
  • При добавлении изображений сопровождайте их пояснительным текстом.

5. Структура статей

  • Начинайте статью с краткого описания темы.
  • Основная часть должна быть разбита на логические разделы.

6. Структура папок в корневом каталоге

  • Если нужно добавить новую папку в корневой каталог, то нужно создать файл index.md внутри этой папки и помимо названия ([[code-of-conduct#^notenaming|см. пункт 1.]]) папки нужно еще вписать ее порядковый номер.

About

No description, website, or topics provided.

Code of conduct

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors