OpenSWPC.github.io/mkdocs.yml at main · OpenSWPC/OpenSWPC.github.io · 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
site_name: "OpenSWPC"
site_description: "OpenSWPC User's Guide"
site_author: "Takuto Maeda"
site_url: "https://OpenSPWC.github.io"

# Repository
repo_name: OpenSWPC/OpenSWPC
repo_url: https://github.com/OpenSWPC/OpenSWPC
edit_uri: ""

copyright: "Copyright &copy Takuto Maeda. All Rights Reserved"

docs_dir: "src"

site_dir: "docs"

use_directory_urls: true

theme:
  language: "en"
  name: "material"
  palette:
    primary: "green"
    accent: "black"
  features:
    - navigation.tabs
    - navigation.top
    - toc.integrate
    - navigation.sections

  logo: fig/icon.png

nav:
  - index.md
  - New_Feature.md
  - How to build:
      - 1._SetUp/0100_trial.md
      - 1._SetUp/0101_env.md
      - 1._SetUp/0102_tree.md
      - 1._SetUp/0103_compile.md
      - 1._SetUp/0104_dataset.md
      - 1._SetUp/0105_parallel.md
  - Parameter settings:
      - 2._Parameters/0201_description.md
      - 2._Parameters/0202_control.md
      - 2._Parameters/0203_coord.md
      - 2._Parameters/0204_visco.md
      - 2._Parameters/0205_output.md
      - 2._Parameters/0206_vmodel.md
      - 2._Parameters/0207_source.md
      - 2._Parameters/0208_abc.md
      - 2._Parameters/0209_checkpoint.md
      - 2._Parameters/0210_reciprocity.md
      - 2._Parameters/0211_2dcode.md
  - Tools:
      - 3._Tools/0301_snapshot.md
      - 3._Tools/0302_vmodel.md
      - 3._Tools/0303_parameter.md
      - 3._Tools/0304_rmedia.md
      - 3._Tools/0305_python.md
      - 3._Tools/0306_misc.md
  - Hints:
      - 4._Hints/0401_modelset.md
      - 4._Hints/0402_modification.md
  - License.md

extra_css:
  - "https://fonts.googleapis.com/earlyaccess/notosansjp.css"
  - "css/custom.css"

plugins:
  - search:
      separator: '[\s\-\.]+'
      lang:
        - en
        - ja
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      languages:
        - build: true
          default: true
          locale: en
          name: English
        - build: true
          default: false
          locale: ja
          name: Japanese
          nav_translations:
            Hints: 計算のヒント
            How to build: ビルドから実行まで
            New features: 新機能
            Parameter settings: パラメタ設定
            Tools: 関連ツール
      reconfigure_material: true
      reconfigure_search: true
extra:
  font:
    code: "Consolas"

markdown_extensions:
  - pymdownx.superfences
  - codehilite:
      linenums: true
      use_pygments: true
  - pymdownx.arithmatex:
      preview: false
  - admonition
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      linenums: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - def_list
  - pymdownx.blocks.caption

extra_javascript:
  - mathjax-config.js
  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML