Правила и рекомендации по наполнению сайта / Alexey Nurgaliev

Загрузка из репозитория и запуск

Этот сайт находится в репозитории GitHub

Для работы с репозиториями рекомендую пользоваться Atlassian SoureTree или ПО от GitHub. Также можно пользоваться консольной программой git.

Для тестирования сайта можно использовать Vagrant (Vagrantfile и скрипт настройки ВМ уже в репозитории). О том, как использовать Vagrant для разработки и тестирования сайта, написано здесь.

Добавление статей

Новые статьи добавляются в папку _posts Имя файла статьи должно соответствовать шаблону: ГГГГ-ММ-ДД-название-статьи Расширение файла зависит от того, какой язык разметки используется:

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

Для обработки markdown используется процессор kramdown. Описание расширенного им синтаксиса markdown можно прочитать на официальном сайте.

Для обработки файлов, содержащих текст, написанный на языке Textile, используется процессор RedCloth. Описание синтаксиса Textile есть на официальном сайте RedCloth.

Файлы с разметкой HTML дополнительно не обрабатываютcя.

В начале файла должен находиться текст с описанием статьи:

---
layout: post
title: Как здесь работать
author: Alexey Nurgaliev
---

Назначение полей:

Также дополнительно можно указать поле section: чтобы поместить статью в специальный раздел сайта.

Далее может располагаться любой текст.

Для оформления страниц можно пользоваться библиотекой Bootstrap.

Подсветка синтаксиса

Для вставки кода с подсвеченным синтаксисом можно воспользоваться специальным тегом:

{% highlight [язык] [linenos] %}
код
{% endhighlight %}

Пример кода с подсветкой синтаксиса:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
class PollViewTest(TestCase):

    def test_indexview_with_no_polls(self):
        response = self.client.get(reverse('polls:index'))
        self.assertEqual(response.status_code, 200)
        self.assertContains(response, "No polls are available")
        self.assertQuerysetEqual(response.context['latest_poll_list'], [])

    def test_index_view_with_a_past_poll(self):
        create_poll(question='Past poll', days=-30)
        response = self.client.get(reverse('polls:index'))
        self.assertQuerysetEqual(response.context['latest_poll_list'],
                                 ['<Poll: Past poll>'])
								 

Математические формулы

Для вставки математических формул можно использовать MathJax.

Формулы должны быть записаны в формате LaTeX. Справочних по LaTeX

Для вставки формулы внутрь строки ее нужно заключить в \( формула \)

Если формула вставляется в отдельную строку, она заключается в $$ формула $$

Замечания по языкам разметки:

Редактирование сайта

Перед началом редактирования рекомендуется почитать документацию по Jekyll.

Назначение каталогов сайта:

Редактирование каталога ссылок

Шаблон для новой группы ссылок:

### Название группы
{: #divN }

|-|-|
[заголовок](ссылка)|описание
{: .table }

[В начало](#)
© Code More Team, 2017
GitHub