finec-mgimo / finec-mgimo.github.io

Финэк МГИМО - программы бакалавриата и магистратуры по экономике, менеджменту, туризму и бизнес-информатике в кампусе МГИМО-Одинцово.
https://finec.mgimo.ru
MIT License
1 stars 8 forks source link

гайдлайн разработчика #45

Open epogrebnyak opened 3 years ago

epogrebnyak commented 3 years ago

@necelentano, просьба развернуть в краткиую рекомендацию и обоснование почему так, по 1 предложению:

necelentano commented 3 years ago

Заголовки

В теле документа md при добавлении контента использовать только заголовки второго уровня и по убыванию h2, h3 и т.д. В md синтаксисе это ## и ### соответственно. Главный заголовок страницы указываем в front matter в поле title.

Зачем так делать? Для SEO правильно чтобы на странице был только один заголовок уровня h1 (в нашем случае это поле title в front matter).

index.md или _index.md

В документации Hugo для отображения страницы нужна индексный файл _index.md (например в нашем проекте это /about/_index.md и /contacts/index.md). Файлы без (нижнего подчеркивания) в начале лучше использовать как контент, который относится к конкретной директории (категории) – например, /program/undergrade/finec-fintech.md. Использование index.md вместо index.md вызывает в консоли Warning типа – "/mnt/*/***/finec-mgimo/content/ru/program/undergrad" have both index. and index.* files, pick one.

дублирование файлов на англ. яз

Так как на сайте реализована поддержка двух языков (RU и EN), то при добавлении контента на RU версию (content/ru) всегда нужно добавлять те же файлы (и папки если есть) в content/en сохраняя структуру RU версии – в принципе можно просто сделать copy/paste добавленных файлов md (и папок если есть) из ru в en версию.

epogrebnyak commented 3 years ago

https://github.com/finec-mgimo/finec-mgimo-v2/issues/52