winsw.github.io/mkdocs.yml at main · winsw/winsw.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
site_name: Windows Service Wrapper
site_description: >-
  Windows Service Wrapper (WinSW) is a tool to wrap and manage Windows services,
  providing a simple way to run applications as Windows services.
copyright: >-
  Copyright &copy; 2026 - Oleg Nenashev and all WinSW contributors.
  The content and the license are licensed under CC BY 4.0.<br/>
repo_url: https://github.com/winsw/winsw.github.io
repo_name: GitHub Repo
edit_uri: edit/main/
site_url: https://winsw.github.io

# Build
site_dir: _site
docs_dir: .
exclude_docs: |
  .github
  .git
  .vscode
  .multirepo
  .devcontainer

nav:
  - Home: v3/README.md
  - Documentation:
    - v2: v2/README.md
    - v3: '!import https://github.com/winsw/winsw?branch=v3'
  - Manifesto: v3/MANIFEST.md
  - Contributing:
    - Contributing to WinSW: v3/CONTRIBUTING.md
    - Contributing to the website: CONTRIBUTING.md
    - License: LICENSE.md

not_in_nav: |
  - versions.json
  - versions.md

plugins:
  - search
  - autorefs
  - macros
  - mkdocs-pdf
  - social
  - same-dir
  - group:
      enabled: !ENV [FULL_BUILD, true]
      plugins:
      - multirepo:
          # TODO: Change to True once works
          cleanup: false
          temp_dir: "winsw.github.io/.multirepo"
          keep_docs_dir: true
          nav_repos:
          - name: v2
            import_url: 'https://github.com/winsw/winsw?branch=v2&edit_uri=/blob/v2/'
            imports: [ /* ]
          - name: v3
            import_url: 'https://github.com/winsw/winsw?branch=v3&edit_uri=/blob/v3/'
            imports: [ /* ]
  - redirects:
      redirect_maps:
        'versions.json': '/assets/data/versions.json'


# Markdown
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: '#'
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - mdx_truly_sane_lists

# Theme
theme:
  name: material
  custom_dir: overrides
  highlightjs: true
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    # NOT compatible with toc.integrate
    # - navigation.indexes
    - navigation.path
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.expand
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  font:
    text: DM Sans
    code: Roboto Mono
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  favicon: assets/images/logo/logo.svg
  logo: assets/images/logo/logo.png
  icon:
    repo: fontawesome/brands/github

extra_css:
  - assets/css/theme.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/winsw
      name: GitHub
  version:
    provider: mike