New-OpenJij-Tutorial/mkdocs.yml at main · OpenJij/New-OpenJij-Tutorial · 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
site_name: 'OpenJij Tutorial'
copyright: 'Copyright © 2022 - Jij Inc.'
repo_url: https://github.com/OpenJij/New-OpenJij-Tutorial
repo_name: OpenJij/New-OpenJij-Tutorial
edit_uri: '' #edit/main/docs/

theme:
  name: material
  logo: assets/OpenJij-Logo.webp
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - header.autohide

nav:
  - 'Home': index.md
  - 'Tutorial' :
    - 'English': tutorial/en
    - 'Japanese': tutorial/ja
  - 'HowToContribute': HowToContribute.md

plugins:
  - mkdocs-jupyter:
     execute: True
     allow_errors: false
     include_source: True
  - git-revision-date-localized:
     locale: en
     fallback_to_build_date: true
     type: timeago
     enable_creation_date: true
  - search
  - awesome-pages
  - autorefs
  - tags
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
  - literate-nav:
      nav_file: SUMMARY.md
      implicit_index: true
  - section-index
  - mkdocs-nav-enhancements
  - htmlproofer:
      raise_error: False

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets
  - pymdownx.critic
  - tables
  - codehilite:
      noclasses: true
      pygments_style: colorful
      linenums: true