Skip to content

Commit

Permalink
Add doc features (#177)
Browse files Browse the repository at this point in the history
* add markdown code execution

* add dark theme, navigation features

* add repo information to top bar
  • Loading branch information
jeffbrennan authored Jan 28, 2024
1 parent 80b92ee commit ff044cd
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 141 deletions.
26 changes: 26 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
site_name: Quinn
site_url: "https://mrpowers.github.io/quinn/"
repo_url: "https://github.com/MrPowers/quinn"
repo_name: "MrPowers/quinn"

theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tracking
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
- navigation.indexes
- navigation.expand
- content.tabs.link
- content.code.copy
- content.code.select

plugins:
- search
Expand All @@ -19,6 +44,7 @@ plugins:
show_if_no_docstring: true
show_source: true
- mkdocs-jupyter
- markdown-exec

nav:
- Home: index.md
Expand Down
Loading

0 comments on commit ff044cd

Please sign in to comment.