TextWatermark/mkdocs.yml at main · JDArmy/TextWatermark · 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
site_name: TextWatermark Docs
repo_url: https://github.com/JDArmy/TextWatermark
site_description: Text Watermark library in Python.
site_author: Monyer
repo_name: GitHub
docs_dir: docs_md
site_dir: docs

theme:
  name: material
  locale: en
  features:
    - content.code.copy
    - toc.integrate
    - toc.follow
    - navigation.tabs
    - navigation.top
    # - navigation.path
    - navigation.tracking
    # - navigation.sections
    # - navigation.expand
    - navigation.prune
  include_sidebar: true

extra_css:
  - css/extra.css
extra_javascript:
  - js/extra.js

watch:
  - src/textwatermark

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
      auto_title: true
      linenums: true
      linenums_style: pymdownx-inline
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - toc:
      baselevel: 2
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - autorefs
  - search
  - include-markdown:
      opening_tag: "{%"
      closing_tag: "%}"
      encoding: utf-8
      preserve_includer_indent: false
      dedent: false
      trailing_newlines: false
      comments: false
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_category_heading: false
            show_root_heading: false
            heading_level: 2
            show_root_members_full_path: false
            show_submodules: false
            merge_init_into_class: false
            show_if_no_docstring: true
  - i18n:
      default_language: zh
      languages:
        zh: Chinese
        en: English
      nav_translations:
        zh:
          Home: 首页
          Usage: 用法
          Example: 样例
          Servitization: 服务化
          Changelog: 更新日志
          API Documents: API 文档
          Templates: 水印模板
          Development Guide: 开发文档
          About: 关于

nav:
  - Home: index.md
  - Usage:
      - Coding: usage.md
      - CMD Line: cmdline.md
  - Example: example.md
  - Templates: templates.md
  - Servitization: servitization.md
  - API Documents:
      - api/main.md
      - WMConversion: api/conversion.md
      - WMTemplate: api/template.md
      - Defines: api/defines.md
      - CMD Line: api/cmdline.md
  - Development Guide: development.md
  - Changelog: changelog.md
  - About: about.md