Skip to content

Commit

Permalink
Create mkdocs.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
judahpaul16 committed Apr 28, 2024
1 parent bc81f6d commit 42d05f1
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,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: mkdocs
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:
- type: 'github'
link: 'https://github.com/judahpaul16/python-urbackup'

0 comments on commit 42d05f1

Please sign in to comment.