Skip to content

Commit db1b76f

Browse files
authored
nimble guide improvements (#1321)
* docs: add repo to mkdocs header * docs: support media queries for color scheme * docs: add edit button * docs: add nim logo * docs: add revision date * docs: add back search plugin
1 parent 5d4d8db commit db1b76f

File tree

3 files changed

+73
-5
lines changed

3 files changed

+73
-5
lines changed

nimble-guide/docs/assets/logo.svg

Lines changed: 48 additions & 0 deletions
Loading

nimble-guide/mkdocs.yml

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,41 @@
11
site_name: Nimble User Guide
2+
repo_url: https://github.com/nim-lang/nimble
3+
repo_name: nim-lang/nimble
4+
edit_uri: edit/master/nimble-guide/docs/
25

36
theme:
47
name: material
8+
logo: assets/logo.svg
9+
favicon: assets/logo.svg
510
features:
611
- navigation.tabs
712
- navigation.tabs.sticky
813
- navigation.expand
914
- navigation.sections
1015
- toc.integrate
16+
- content.action.edit
1117
palette:
12-
- scheme: default
13-
primary: teal
18+
# Palette toggle for automatic mode
19+
- media: "(prefers-color-scheme)"
20+
toggle:
21+
icon: material/brightness-auto
22+
name: Switch to light mode
23+
24+
# Palette toggle for light mode
25+
- media: "(prefers-color-scheme: light)"
26+
scheme: default
27+
primary: black
1428
toggle:
1529
icon: material/brightness-7
1630
name: Switch to dark mode
17-
- scheme: slate
31+
32+
# Palette toggle for dark mode
33+
- media: "(prefers-color-scheme: dark)"
34+
scheme: slate
1835
primary: black
1936
toggle:
2037
icon: material/brightness-4
21-
name: Switch to light mode
22-
38+
name: Switch to system preference
2339

2440

2541
use_directory_urls: false
@@ -32,6 +48,9 @@ markdown_extensions:
3248
- pymdownx.snippets
3349
- pymdownx.superfences
3450

51+
plugins:
52+
- search
53+
- git-revision-date-localized
3554

3655
nav:
3756
- Home:

nimble-guide/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
mkdocs-material>=9.5
2+
mkdocs-git-revision-date-localized-plugin

0 commit comments

Comments
 (0)