/ps-group.github.io

Github pages for programming courses in IPS and Volgatech

Primary LanguageHTMLOtherNOASSERTION

ps-group.github.io

Сайт с материалами курсов Института ПС.

Процесс разработки

Сайт полностью статический (HTML, CSS, JS), собирается из Markdown и SCSS с помощью Jekyll. Сайт ps-group.github.io хостится на сервисе Github Pages, который использует тот же Jekyll.

Jekyll на машине разработчика доступен как утилита командной строки. Основные команды:

jekyll serve

При запуске в каталоге проекта команда компилирует Markdown и SCSS, а затем запускает веб-сервер. При изменении любого файла в каталоге проекта сайт пересобирается в течении ~10сек.

jekyll build

Команда однократно компилирует Markdown и SCSS без запуска веб-сервера и без наблюдения изменений. Выходные файлы лежат в подкаталоге ./_site.

Соглашения

  • Файлы именуются через нижнее подчёркивание: html_canvas_part1.md
  • Статьи лежат в коллекциях, каждая коллекция имеет свой каталог; список коллекций ищите в свойстве collections в файле _config.yaml
  • Изображения могут иметь формат PNG, JPEG, GIF или SVG, и лежат в подкаталоге img каждой коллекции

При добавлении новой статьи поместите её в подходящую коллекцию. Создавать новую коллекцию нежелательно.

Каждый файл с Markdown-разметкой должен иметь в начале файла блок метаинформации (возможно, пустой), обрамлённый разделителем ---\n. Старайтесь для каждой статьи иметь свойства title, preview и subtitle. Пример метаинформации:

---
title: Рисуем на OpenGL
preview: figures/lesson_3_preview.png
subtitle: В статье мы научимся использовать систему событий SDL2 и рисовать фигуры средствами OpenGL в блоках glBegin/glEnd.
---

Лицензия

Материалы сайта распространяются на условиях Creative Commons Attribution-ShareAlike 3.0 unported. Текст лицензии в Markdown-разметке находится в файле LICENSE.md.

Благодарности

Настройка сайта и разработка статей:

  • Сергей Шамбир
  • Василий Усков

Поиск опечаток и предложения по улучшению:

  • Никита Егоров, лицей Инфотех
  • Владимир Данилевский, ИПС
  • Студенты группы ПС 2014-2018