-
Notifications
You must be signed in to change notification settings - Fork 151
/
Copy pathmkdocs.yml
83 lines (69 loc) · 2.35 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
site_name: gyuho
# https://github.com/mrdbourke/pytorch-deep-learning/blob/main/mkdocs.yml
theme:
name: material
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/
font:
text: Roboto
code: Roboto Mono
features:
- navigation.top
- navigation.indexes
- search.suggest
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color
palette:
# primary: light-blue
# accent: light-blue
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
markdown_extensions:
- meta
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.arithmatex:
generic: true
extra_javascript:
- docs/javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
# https://github.com/danielfrg/mkdocs-jupyter
- mkdocs-jupyter:
execute: false
include_source: true
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/
- blog:
blog_dir: blog
authors_file: "{blog}/.authors.yml"
archive_name: Archive
# https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
nav:
- Home: index.md
- About me: aboutme.md
- Consensus systems:
- Paxos(etcd) vs. Nakamoto(Bitcoin): ./consensus-systems/paxos-etcd-vs-nakamoto-bitcoin.md
- Nakamoto(Bitcoin) vs. Snow(Avalanche): ./consensus-systems/nakamoto-bitcoin-vs-snow-avalanche.md
- Blog:
- blog/index.md
# https://www.mkdocs.org/user-guide/configuration/#not_in_nav
not_in_nav: |
/nakamoto-bitcoin-vs-snow-avalanche-consensus.html.md
/paxos-etcd-vs-nakamoto-bitcoin-consensus.html.md
/consensus-systems/nakamoto-bitcoin-vs-snow-avalanche-consensus/snowman-example
exclude_docs: |
/consensus-systems/nakamoto-bitcoin-vs-snow-avalanche-consensus/snowman-example