# Документация MathCAT

Документация собирается с помощью [Jekyll](https://jekyllrb.com/) с темой Cayman и публикуется на GitHub Pages.

## Поддержка нескольких языков

Переводы находятся в подкаталогах языков (например, `ru/` для русского языка). Каждая переведённая страница должна содержать front matter с полями `lang` и `ref`:

```yaml
---
layout: default
lang: ru
ref: users
title: Руководство пользователя MathCat
---
```

- `lang` — код языка страницы;
- `ref` — общий идентификатор, связывающий переводы одной и той же страницы (например, поле `ref: users` должно быть и в `users.md`, и в `ru/users.md`).

Переключатель языков в `_layouts/default.html` использует эти поля для создания ссылок между переводами. Он отображается только на страницах, у которых задано поле `ref`.

Чтобы зарегистрировать новый язык, добавьте его в `_data/languages.yml`.

## Локальная разработка

Запустите _Jekyll_ из корневого каталога репозитория:

```
docker run --rm -v "${PWD}/docs:/srv/jekyll" -p 4000:4000 jekyll/jekyll bash -c "bundle install && bundle exec jekyll serve --host 0.0.0.0"
```

Затем откройте http://localhost:4000, http://localhost:4000/fi/users и т. д.
