nautical-backup/mkdocs.yml at main · Minituff/nautical-backup · 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
155
156
157
158
159
160
161
162
site_name: Nautical Backup
site_description: 'A simple Docker volume backup tool.'
site_author: 'James Tufarelli'
site_url: 'https://minituff.github.io/nautical-backup/'
edit_uri: 'edit/main/docs/'

# Repository
repo_name: 'GitHub'
repo_url: 'https://github.com/minituff/nautical-backup'

# copyright: 'Copyright &copy; 2023 James Tufarelli'


# Plugins
plugins:
  # - site-urls
  # git-revision-date-localized:
  #   enable_creation_date: true
  # offline:
  - search
  # minify:
  #   minify_html: true
  # autolinks:
  # git-revision-date-localized:
  #   type: date
  #   fallback_to_build_date: true
  # macros:
  #   verbose: true
  #   include_dir: _includes
  # meta-descriptions: # If not provided, auto-generate a description (https://pypi.org/project/mkdocs-meta-descriptions-plugin/)
  # meta:

nav:
 - Home: index.md
 - Introduction: introduction.md
 - Installation: installation.md
 - Environment Variables: arguments.md
 - Docker Labels: labels.md
 - Updating Nautical: updates.md
 - Rest API: rest-api.md
 - Docker Socket Proxy: docker-socket-proxy.md
 - Advanced Usage:
   - Source & Destination Mappings: advanced/advanced.md
   - NFS Shares: advanced/nfs-share.md
   - Remote Backups: advanced/remote-backups.md
   - Homepage Dashboard: advanced/homepage-dashboard.md
 - Q & A: q-and-a.md
 - Developer Documentation:
   - Dev Container: developers/dev-container.md
   - Tests: developers/tests.md
   - Contributing to the Docs: developers/docs.md
   - Developer Env Variables: developers/env.md

watch:
  - snippets
  - docs
  - mkdocs.yml

extra:
  generator: false  # "false" will Remove the "Made with Material for MkDocs" branding
  # version:
  #   provider: mike

theme:
  name: material
  logo: media/Logo-large.png
  features:
    # - navigation.tabs
    # - navigation.tabs.sticky
    # - navigation.sections
    - navigation.indexes # Allow index pages for section
    - navigation.instant
    - navigation.top # Back to top button
    # - navigation.prune
    - navigation.path
    - navigation.tracking
    # - navigation.expand
    - search.suggest
    - search.share
    - search.highlight
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - header.autohide
    - announce.dismiss
    - toc.follow
    # - toc.integrate # Table of contents on the left
    - content.action.edit
    - content.action.view
    - navigation.footer  # Add the `prev` and `next` buttons in the footer
  # font:
  #   text: 'Ubuntu'
  #   code: 'Ubuntu Mono'
  palette:
    # scheme: slate

    # Toggle light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Burn my eyes!

    # Toggle dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Love my eyes!

extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - abbr
  - attr_list
  - admonition
  - def_list
  - codehilite:
      linenums: true
  - toc:
      permalink: true  # Allow perma-linking the headers
      toc_depth: 6 # ignore H4/5/6
  - footnotes
  - pymdownx.critic
  - pymdownx.keys
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.snippets:
      check_paths: true
      base_path: snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: funkypenguin
      repo: geek-cookbook
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: false
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - meta
  - md_in_html