Skip to content

Commit 1569022

Browse files
authored
Merge pull request #201 from britive/docs/dark-mode
docs:update-mkdocs-theme-and-verbiage
2 parents 7d3c85a + 1538883 commit 1569022

File tree

4 files changed

+31
-4
lines changed

4 files changed

+31
-4
lines changed

docs/assets/favicon.png

1.68 KB
Loading

docs/assets/logo.png

7.51 KB
Loading

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Welcome to PyBritive
22

3-
For full documentation visit [docs.britive.com](https://docs.britive.com).
3+
Full Britive documentation is available here: [docs.britive.com](https://docs.britive.com).
44

5-
PyBritive is intended to be used as a CLI application for communicating with the Britive Platform.
5+
`pybritive` is intended to be used as a CLI application for interacting with the Britive Platform.
66

77
## Requirements
88

mkdocs.yml

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,45 @@
1-
site_name: pybritive documentation
1+
site_name: PyBritive
22
nav:
33
- Documentation: index.md
44
- Resources:
55
- Support: https://support.britive.com
66
- Company Home Page: https://www.britive.com
77
- GitHub Repo: https://github.com/britive/python-cli
8-
theme: readthedocs
8+
theme:
9+
logo: assets/logo.png
10+
favicon: assets/favicon.png
11+
name: material
12+
features:
13+
- toc.integrate
14+
- toc.follow
15+
hide:
16+
- path
17+
palette:
18+
- media: "(prefers-color-scheme)"
19+
toggle:
20+
icon: material/brightness-auto
21+
name: Switch to dark mode
22+
- media: "(prefers-color-scheme: dark)"
23+
primary: black
24+
scheme: slate
25+
toggle:
26+
icon: material/brightness-4
27+
name: Switch to light mode
28+
- media: "(prefers-color-scheme: light)"
29+
primary: blue
30+
scheme: default
31+
toggle:
32+
icon: material/brightness-7
33+
name: Switch to system preference
934
repo_url: https://github.com/britive/python-cli
1035
edit_uri: ""
1136
copyright: 2025 Britive, Inc.
1237
markdown_extensions:
1338
- attr_list
1439
- mkdocs-click
1540
- admonition
41+
- toc:
42+
toc_depth: 3
1643
watch:
1744
- src/pybritive/commands/
1845
- src/pybritive/

0 commit comments

Comments
 (0)