genai-mkdocs-sample/mkdocs.yml at main · genai-docs/genai-mkdocs-sample · 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
site_name: 生成AI時代のドキュメント基盤
site_description: Best practices for business system documentation and a collection of Mermaid diagram samples
site_author: Documentation Team
copyright: Copyright &copy; 2024 @nuits.jp

theme:
  name: material
  language: ja
  features:
    - content.code.copy

extra_css:
  - stylesheets/site.css

extra_javascript:
  - https://unpkg.com/mermaid/dist/mermaid.min.js

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.highlight
  - toc:
      permalink: true

watch:
  - docs
  - mkdocs.yml

plugins:
  - search
  - awesome-pages
  - mermaid-to-svg:
      enabled_if_env: RENDER_SVG
      image_id_enabled: true
      image_id_prefix: mermaid-diagram
      # Disable HTML labels for PDF compatibility
      mermaid_config:
        htmlLabels: false
        flowchart:
          htmlLabels: false
        class:
          htmlLabels: false
  - svg-to-png:
      enabled_if_env: RENDER_PNG
  - to-pdf:
      cover_subtitle: 'ドキュメンテーション戦略'
      toc_title: 目次
      toc_level: 3
      output_path: pdf/ドキュメンテーション戦略.pdf
      enabled_if_env: ENABLE_PDF
  - table-reader:
      enabled: true