From 42d05f1e64af12a90b0f2cde42680830c29be5f0 Mon Sep 17 00:00:00 2001 From: judahpaul16 Date: Sun, 28 Apr 2024 02:25:02 -0400 Subject: [PATCH] Create mkdocs.yaml --- mkdocs.yml | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..677e6c8 --- /dev/null +++ b/mkdocs.yml @@ -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'