satori-docs/mkdocs.yml at main · ukatech/satori-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
site_name: 里々マニュアル
site_description: 伺かの SHIORI「里々（SATORI）」と同梱 SAORI「ssu」の仕様書
site_url: https://ukatech.shillest.net/satori-docs/
repo_url: https://github.com/ukatech/satori-docs
repo_name: ukatech/satori-docs
edit_uri: ""

# 原稿はリポジトリ直下にあるため、scripts/prepare_site.py で _site_src/ に写してからビルドする
docs_dir: _site_src
site_dir: _site

theme:
  name: material
  # Zensical の既定は modern（新デザイン）。従来の見た目は classic
  variant: classic
  # OGP などの <head> の追加（overrides/main.html）
  custom_dir: overrides
  logo: assets/logo.png
  favicon: assets/logo.png
  language: ja
  features:
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: ダークモードに切り替え
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: ライトモードに切り替え

# ページごとの OGP（overrides/main.html が使う）。キーはページの URL（トップは ""）、image は site_url からの相対パス（1200x630）
extra:
  ogp:
    other/satori2-launch/:
      title: 里々 Unicode 版（Mc202-1）公開
      description: 内部を Unicode にした里々を正式版として公開します。今までの辞書・セーブデータ・SAORI はそのまま動きます。ゴースト作者が気にする違いをまとめました。
      image: assets/satori2/ogp.png

extra_css:
  - assets/extra.css

extra_javascript:
  - assets/copy-tab.js

plugins:
  - search:
      lang: ja
  - awesome-nav

markdown_extensions:
  - tables
  - admonition
  - attr_list
  - md_in_html
  - mdx_truly_sane_lists
  - pymdownx.superfences
  - toc:
      permalink: true
      # 右の目次は H3 まで（関数ページは関数名だけ、文法ページは章と節だけにする）
      toc_depth: 3
      # GitHub と同じく日本語の見出しをそのままアンカーにする
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower

validation:
  links:
    anchors: warn