vercel-mkdocs-material/mkdocs.yml at main · kaitas/vercel-mkdocs-material · 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
site_name: Vercel-MkDocs-Material
site_url: https://vercel-mkdocs-material.vercel.app/
site_description: Vercel-MkDocs-Material is a Material Design theme for MkDocs, a static site generator geared towards (technical) project documentation. It is built with Material Components for the Web, a framework that implements Material Design guidelines from Google.
site_author: Akihiko Shirai
site_dir: public
repo_url: https://github.com/kaitas/vercel-mkdocs-material
repo_name: vercel-mkdocs-material


theme:
  name: material
  palette:
    primary: indigo
    accent: pink
  font:
    text: Noto Sans JP
    code: Inconsolata
  features:
    - content.code.annotate
    - navigation.tabs
    - navigation.sticky
#    - navigation.sections
    - navigation.top
    - header.autohide
    - announce.dismiss
  icon:
    repo: fontawesome/brands/github
  custom_dir: overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: pink
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: red
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

nav:
  - Home: index.md
  - Blog: blog/index.md
  - Vercel: vercel.md
  - Actions: https://github.com/kaitas/2025/blob/main/.github/workflows/mkdocs.yml
  - About: about.md

plugins:
  search:
    lang: 'ja'
  blog: #https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_dir
#    blog_dir: .
    blog_toc: true
#   post_url_format: # default is yyyy/mm/dd/{slug}
#    post_slugify: !!python/object/apply:pymdownx.slugs.slugify
#    kwds:
#    case: lower
  tags:

extra:
#  analytics:
#    provider: google
#    property: G-DQDGMD4GSE
  alternate:
    - name: English
      link: /
      lang: en
    - name: Japanese
      link: /ja/
      lang: ja
  consent:
    title: Cookie consent
    description:
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/o_ob
      name: o_ob on X
    - icon: fontawesome/brands/github
      link: https://github.com/kaitas/vercel-mkdocs-material
  generator: false

extra_javascript:
  - javascripts/github-calendar.min.js
  - https://platform.twitter.com/widgets.js
  - js/custom_twitter.js
#  - js/mathjax.js
#  - https://polyfill.io/v3/polyfill.min.js?features=es6
#  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/github-calendar-responsive.css
  - stylesheets/extra.css # https://squidfunk.github.io/mkdocs-material/customization/#additional-css
  - https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css

markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - meta
  - toc:
      permalink: true
  - admonition
  - footnotes
  - def_list
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.smartsymbols
  - pymdownx.keys
  - pymdownx.highlight:
      use_pygments: true
      noclasses: true
      pygments_style: monokai
      linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details