python-urbackup/mkdocs.yml at master · judahpaul16/python-urbackup · 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
# MkDocs configuration

# Required
site_name: 'Python UrBackup'
site_description: 'A Python wrapper to access and control an UrBackup server'
site_author: 'Judah Paul'
repo_name: 'judahpaul16/python-urbackup'
repo_url: 'https://github.com/judahpaul16/python-urbackup'
docs_dir: 'docs'
site_dir: 'site'

# Theme configuration
theme:
  name: material
  color_mode: auto
  user_color_mode_toggle: true
  locale: en
  features:
    - tabs
  palette:
    primary: 'indigo'
    accent: 'indigo'
  logo: 'https://www.urbackup.org/favicon.ico'
  favicon: 'https://www.urbackup.org/favicon.ico'

# Extensions
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true

# Plugins
plugins:
  - search
  - git-revision-date-localized

# Extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: 'https://github.com/judahpaul16/python-urbackup'