Skip to content

Commit 4adb752

Browse files
fizrukfizruk
committed
Merge branch 'release-v0.7.2'
* release-v0.7.2: (31 commits) Bump version and update changelogs Move the blog out of versioned docs Replace manual string manipulation with tokens Update rzk/src/Rzk/Main.hs Throw an error when rzk.yaml `include` is empty Replace `setDifference` with `stripInfix` Add RSS feed for the blog Fix first post's date Add a page mentioning/comparing with other HoTT assistants Fix rzk.yaml Set up blog (in English version), use navigation.indexes Fix site_url Use mkdocs-material[imaging] Ignore .cache/ Fix plugins (no deep merge), integrate ToC, social Select better fonts for English and Russian Update global rzk.yaml to match English docs Fix Rzk check for docs Clean up some docs and translate some to Russian Remove redundant emoji plugin (supported natively since MkDocs Material 9.4) ...
2 parents eabfe3c + a6e140a commit 4adb752

File tree

91 files changed

+3314
-731
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+3314
-731
lines changed

‎.github/workflows/mkdocs.yml‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: MKDocs
22

33
on:
44
push:
5-
branches: [develop]
5+
branches: [develop,mkdocs-*]
66
tags: [v*]
77
paths:
88
- .github/workflows/mkdocs.yml
@@ -37,6 +37,12 @@ jobs:
3737
rename-to: rzk
3838
chmod: 0755
3939

40+
- name: Check Rzk files for each language
41+
run:
42+
for lang_dir in $(ls -d docs/docs/*/); do
43+
pushd ${lang_dir} && rzk typecheck; popd ;
44+
done
45+
4046
- name: 🔨 Install MkDocs Material and mike
4147
run: pip install -r docs/requirements.txt
4248

@@ -46,11 +52,16 @@ jobs:
4652
git config --local user.name "github-actions[bot]"
4753
4854
- name: 🚀 Deploy with mike (${{ github.ref_name }}, latest)
49-
if: ${{ github.ref_name != 'develop' }}
55+
if: ${{ github.ref_name != 'develop' && !startsWith(github.ref_name, 'mkdocs') }}
5056
run: |
51-
mike deploy --push --update-aliases --config-file docs/mkdocs.yml ${{ github.ref_name }} latest
57+
for config in $(ls docs/config/*/mkdocs.yml); do
58+
mike deploy --push --update-aliases --config-file ${config} ${{ github.ref_name }} latest;
59+
mike set-default latest --config-file ${config} --push;
60+
done
5261
5362
- name: 🚀 Deploy with mike (${{ github.ref_name }})
54-
if: ${{ github.ref_name == 'develop' }}
63+
if: ${{ github.ref_name == 'develop' || startsWith(github.ref_name, 'mkdocs') }}
5564
run: |
56-
mike deploy --push --config-file docs/mkdocs.yml ${{ github.ref_name }}
65+
for config in $(ls docs/config/*/mkdocs.yml); do
66+
mike deploy --push --config-file ${config} ${{ github.ref_name }};
67+
done

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
.cache/
12
.DS_Store
23
docs/out/
4+
docs/generated/
35
dist
46
dist-*
57
cabal-dev
@@ -33,4 +35,4 @@ __pycache__
3335
*.fls
3436
*.log
3537
rzk/doc/
36-
/rzk-playground-release
38+
/rzk-playground-release

‎CITATION.cff‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ authors:
88
- family-names: Danko
99
given-names: Danila
1010
title: "Rzk: a proof assistant for synthetic $\\infty$-categories"
11-
version: 0.7.1
11+
version: 0.7.2
1212
url: "https://github.com/rzk-lang/rzk"

‎docs/docs/CONTRIBUTORS.md‎ renamed to ‎CONTRIBUTORS.md‎

File renamed without changes.

‎docs/config/base.yml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
repo_url: https://github.com/rzk-lang/rzk
2+
repo_name: rzk-lang/rzk
3+
4+
theme:
5+
name: material
6+
custom_dir: '../../overrides/'
7+
favicon: assets/images/favicon.png
8+
logo: assets/images/logo-1000x1000.png
9+
icon:
10+
repo: fontawesome/brands/github
11+
edit: material/pencil
12+
view: material/eye
13+
features:
14+
- content.code.copy
15+
- content.action.edit
16+
- navigation.footer
17+
- navigation.tabs
18+
- navigation.tabs.sticky
19+
- navigation.sections
20+
- navigation.prune
21+
- navigation.path
22+
- navigation.indexes
23+
- toc.integrate
24+
25+
extra_javascript:
26+
- javascript/mathjax.js
27+
- https://polyfill.io/v3/polyfill.min.js?features=es6
28+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
29+
30+
extra_css:
31+
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
32+
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/default.min.css
33+
- assets/css/rzk-render.css
34+
35+
markdown_extensions:
36+
- admonition
37+
- footnotes
38+
- pymdownx.details
39+
- pymdownx.snippets:
40+
base_path:
41+
- .
42+
- ..
43+
check_paths: true
44+
- mdx_math
45+
- pymdownx.highlight:
46+
anchor_linenums: true
47+
line_spans: __span
48+
pygments_lang_class: true
49+
- pymdownx.inlinehilite
50+
- pymdownx.snippets
51+
- pymdownx.superfences
52+
- toc:
53+
permalink: true
54+
- pymdownx.arithmatex:
55+
generic: true
56+
- attr_list
57+
58+
extra:
59+
version:
60+
provider: mike
61+
alternate:
62+
- name: English
63+
link: /rzk/en/
64+
lang: en
65+
- name: Русский
66+
link: /rzk/ru/
67+
lang: ru

‎docs/config/en/mkdocs.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
INHERIT: "../base.yml"
2+
site_url: https://rzk-lang.github.io/rzk/en/
3+
site_name: "Rzk proof assistant"
4+
site_description: "An experimental proof assistant for simplicial type theory and synthetic ∞-categories."
5+
site_author: "Nikolai Kudasov"
6+
docs_dir: '../../docs/en'
7+
site_dir: '../../generated/en'
8+
edit_uri: edit/develop/docs/docs/en/
9+
10+
nav:
11+
- About:
12+
- index.md
13+
- Community: community.md
14+
- Tools: tools.md
15+
- Contributors: CONTRIBUTORS.md
16+
- Changelog: CHANGELOG.md
17+
- Other proof assistants: related.md
18+
- Getting Started:
19+
- getting-started/index.md
20+
- Install: getting-started/install.md
21+
- Quickstart: getting-started/quickstart.rzk.md
22+
- Depedent Types: getting-started/dependent-types.rzk.md
23+
- Setting up an Rzk project: getting-started/project.md
24+
- Reference:
25+
- Introduction: reference/introduction.rzk.md
26+
- Cube layer: reference/cube-layer.rzk.md
27+
- Tope layer: reference/tope-layer.rzk.md
28+
- Dependent types: reference/type-layer.rzk.md
29+
- Tope disjunction elimination: reference/tope-disjunction-elimination.rzk.md
30+
- Extension types: reference/extension-types.rzk.md
31+
- Organizational features:
32+
- Sections and Variables: reference/sections.rzk.md
33+
- Builtins:
34+
- Directed interval: reference/builtins/directed-interval.rzk.md
35+
- Unit type: reference/builtins/unit.rzk.md
36+
- Commands:
37+
- Define and Postulate: reference/commands/define-postulate.rzk.md
38+
- Compute: reference/commands/compute.rzk.md
39+
- Check: reference/commands/check.rzk.md
40+
- Options: reference/commands/options.rzk.md
41+
- Other:
42+
- Rendering Diagrams: reference/render.rzk.md
43+
- Examples:
44+
- Weak tope disjunction elimination: examples/recId.rzk.md
45+
- Playground: playground/index.html
46+
- Blog: blog/index.html
47+
48+
theme:
49+
language: en
50+
font:
51+
text: Inria Sans
52+
palette:
53+
# Palette toggle for light mode
54+
- media: "(prefers-color-scheme: light)"
55+
primary: white
56+
scheme: default
57+
toggle:
58+
icon: material/brightness-7
59+
name: "Switch to dark mode"
60+
# Palette toggle for dark mode
61+
- media: "(prefers-color-scheme: dark)"
62+
primary: black
63+
scheme: slate
64+
toggle:
65+
icon: material/brightness-4
66+
name: "Switch to light mode"
67+
68+
plugins:
69+
- social
70+
- mike:
71+
deploy_prefix: 'en/'
72+
- search:
73+
lang: en
74+
- rzk:
75+
render_svg: true
76+
anchor_definitions: true

‎docs/config/ru/mkdocs.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
INHERIT: "../base.yml"
2+
site_url: https://rzk-lang.github.io/rzk/ru/
3+
site_name: "Решатель теорем Rzk"
4+
site_description: "Экспериментальный решатель теорем для симплициальной теории типов и синтетических ∞-категорий."
5+
site_author: "Николай Кудасов"
6+
docs_dir: '../../docs/ru'
7+
site_dir: '../../generated/ru'
8+
edit_uri: edit/develop/docs/docs/ru/
9+
10+
nav:
11+
- О проекте:
12+
- index.md
13+
- Сообщество: community.md
14+
- Инструменты: tools.md
15+
- Участники (англ.): CONTRIBUTORS.md
16+
- История изменений (англ.): CHANGELOG.md
17+
- Другие решатели: related.md
18+
- Первые шаги:
19+
- getting-started/index.md
20+
- Установка: getting-started/install.md
21+
- Быстрое начало: getting-started/quickstart.rzk.md
22+
- Введение в зависимые типы: getting-started/dependent-types.rzk.md
23+
- Настройка проекта: getting-started/project.md
24+
- Руководство:
25+
- Введение: reference/introduction.rzk.md
26+
- Слой кубов: reference/cube-layer.rzk.md
27+
- Слой форм: reference/tope-layer.rzk.md
28+
- Зависимые типы: reference/type-layer.rzk.md
29+
- Устранение объединений форм: reference/tope-disjunction-elimination.rzk.md
30+
- Типы-расширения: reference/extension-types.rzk.md
31+
- Организация кода:
32+
- Разделы и предпосылки: reference/sections.rzk.md
33+
- Встроенные определения:
34+
- Направленный интервал: reference/builtins/directed-interval.rzk.md
35+
- Единичный тип: reference/builtins/unit.rzk.md
36+
- Команды:
37+
- Определения и постулаты: reference/commands/define-postulate.rzk.md
38+
- Вычисления: reference/commands/compute.rzk.md
39+
- Проверка типов: reference/commands/check.rzk.md
40+
- Опции решателя: reference/commands/options.rzk.md
41+
- Другое:
42+
- Отрисовка диаграм: reference/render.rzk.md
43+
- Примеры:
44+
- Слабое устранение объединений форм: examples/recId.rzk.md
45+
- Песочница: playground/index.html
46+
- Блог (англ.): blog/index.html
47+
48+
theme:
49+
language: ru
50+
font:
51+
text: PT Sans
52+
palette:
53+
# Palette toggle for light mode
54+
- media: "(prefers-color-scheme: light)"
55+
primary: white
56+
scheme: default
57+
toggle:
58+
icon: material/brightness-7
59+
name: "Переключить на тёмный режим"
60+
# Palette toggle for dark mode
61+
- media: "(prefers-color-scheme: dark)"
62+
primary: black
63+
scheme: slate
64+
toggle:
65+
icon: material/brightness-4
66+
name: "Переключить на светлый режим"
67+
68+
plugins:
69+
- social
70+
- mike:
71+
deploy_prefix: 'ru/'
72+
- search:
73+
lang: ru
74+
- rzk:
75+
render_svg: true
76+
anchor_definitions: true

0 commit comments

Comments
 (0)