aboutsummaryrefslogtreecommitdiffstats
path: root/mkdocs.yml
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-10-10 23:11:16 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-10-10 23:11:16 -0400
commitc500a84b35338ac0f429133a0b07ced8d457976f (patch)
tree54d526e4c07c0171f8e6f41933b607a8ab09127c /mkdocs.yml
parentAdd note on contributing guide to README (diff)
downloadcli-c500a84b35338ac0f429133a0b07ced8d457976f.zip
Refactor docs to use mkdocs and sourcehut pages
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml52
1 files changed, 52 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..8341794
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,52 @@
+site_name: Bolt
+site_url: https://eugenetriguba.srht.site/bolt/
+site_description: A command-line tool for database migrations
+site_author: Eugene Triguba
+repo_url: https://git.sr.ht/~eugenetriguba/bolt
+repo_name: ~eugenetriguba/bolt
+
+theme:
+ name: material
+ palette:
+ - scheme: default
+ primary: indigo
+ accent: indigo
+ toggle:
+ icon: material/brightness-7
+ name: Switch to dark mode
+ - scheme: slate
+ primary: indigo
+ accent: indigo
+ toggle:
+ icon: material/brightness-4
+ name: Switch to light mode
+ features:
+ - navigation.instant
+ - navigation.tracking
+ - navigation.tabs
+ - navigation.sections
+ - navigation.expand
+ - navigation.top
+ - search.suggest
+ - search.highlight
+ - content.code.copy
+
+markdown_extensions:
+ - admonition
+ - pymdownx.details
+ - pymdownx.superfences
+ - pymdownx.highlight:
+ anchor_linenums: true
+ - pymdownx.inlinehilite
+ - pymdownx.snippets
+ - toc:
+ permalink: true
+
+nav:
+ - Home: index.md
+ - Installation: installation.md
+ - Tutorial: tutorial.md
+ - How-To Guides: how-to.md
+ - Reference: reference.md
+ - Explanation: explanation.md
+ - Contributing: contributing.md