lde/mkdocs.yml at master · wate/lde · 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
137
138
139
140
141
142
143
144
145
---
site_name: システムドキュメント
##「sitemap.xml」を正しく出力するには「site_url」の設定を有効化する必要あり
site_url: http://doc.example.com/
theme:
  # https://squidfunk.github.io/mkdocs-material/
  name: material
  language: ja
  # palette:
  #   scheme: default
  #   primary: indigo
  #   accent: indigo
  font:
    # https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/
    text: BIZ UDPGothic
    # code: CodeFontBD
  features:
    - navigation.tabs.sticky
    - content.code.copy
    # - content.tooltips
    # - navigation.tabs
    # - navigation.sections
    # - navigation.expand
    # - navigation.indexes
    - search.suggest
    - search.highlight
    # - search.share
# nav:
#   - ホーム: index.md
#   - 機能一覧: features/
#   - システム構成: architecture.md
#   - データ構造: data_structure.md
#   - テーブル定義: schema/
#   - ディレクトリ構造: directory_structure.md
#   - 開発環境の構築: setup_environment.md
#   - Gitの運用方法: git_operation.md
#   - デプロイ方法: deploy.md
# docs_dir: docs
# site_dir: site
# custom_dir: overrides
# repo_name: wate/lde
# repo_url: https://github.com/wate/lde
extra_javascript:
  - assets/javascripts/extra.js
  # - /pagefind/pagefind-ui.js
extra_css:
  # - /pagefind/pagefind-ui.css
  - assets/stylesheets/extra.css
markdown_extensions:
  ## Python Markdown
  ## @see https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
  ### Abbreviations
  - abbr
  ### Admonition
  - admonition
  ### Attribute Lists
  - attr_list
  ### Definition Lists
  - def_list
  ### Footnotes
  - footnotes
  ### Markdown in HTML
  - md_in_html
  ### Table of Contents
  # - toc
  ### Tables
  - tables
  ## Python Markdown Extensions
  ## @see https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/
  ### BetterEm
  - pymdownx.betterem
  ### Caret, Mark & Tilde
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  ### Details
  - pymdownx.details
  ### Highlight
  - pymdownx.highlight:
      anchor_linenums: true
  ### InlineHilite
  - pymdownx.inlinehilite
  ### Keys
  # - pymdownx.keys
  ### SmartSymbols
  # - pymdownx.smartsymbols
  ### Snippets
  - pymdownx.snippets:
      base_path: docs
      auto_append:
        - includes/abbreviations.md
        - includes/links.md
  ### Tabbed
  # - pymdownx.tabbed
  ### SuperFences
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  ## PlantUML Extension for Python-Markdown
  ## @see https://github.com/mikitex70/plantuml-markdown
  - plantuml_markdown:
      server: http://www.plantuml.com/plantuml

## Excluded doc files
## @see https://www.mkdocs.org/about/release-notes/#excluded-doc-files
exclude_docs: |
  rules
  includes
  SUMMARY.md
  assets/stylesheets/*.map
  assets/stylesheets/*.scss
## Validation
## @see https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn
plugins:
  ## https://squidfunk.github.io/mkdocs-material/plugins/search/
  - search:
      lang: ja
  ## https://squidfunk.github.io/mkdocs-material/plugins/tags/
  - tags
  ## https://github.com/blueswen/mkdocs-glightbox
  - glightbox
  ## https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
  - git-revision-date-localized:
      type: iso_date
      timezone: Asia/Tokyo
      locale: ja
  ## https://oprypin.github.io/mkdocs-section-index/
  - section-index
  ## https://oprypin.github.io/mkdocs-literate-nav/
  - literate-nav:
      # nav_file: SUMMARY.md
  ## https://github.com/landmaj/mkdocs-d2-plugin
  - d2
  ## https://github.com/tuunit/mkdocs-drawio
  - drawio
  ## https://squidfunk.github.io/mkdocs-material/plugins/blog/
  # - blog
  ## https://squidfunk.github.io/mkdocs-material/plugins/offline/
  # - offline