-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
128 lines (119 loc) · 3.1 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# site info
site_name: BlueAutomata
site_url: "https://keanteng.github.io/blueautomata/"
site_author: 'keanteng'
site_description: 'A documentation for the package - BlueAutomata'
# navigation
nav:
- Home: index.md
- Case Study: casestudy.md
- Concepts: concepts.md
- Functions: functions.md
- VBA/Macros: vba_integrate.md
- Notebooks:
- notebooks/01BlueAutomata.ipynb
- notebooks/02AutomataReport.ipynb
- notebooks/03Inconsistency.ipynb
- notebooks/04SystemCube.ipynb
- notebooks/05BatchExport.ipynb
- notebooks/06AutomateVBA.ipynb
edit_uri: edit/main/docs/
# site theme
theme:
name: material
palette:
- scheme: default
primary: lime
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: lime
accent: brown
toggle:
icon: material/toggle-switch
name: Switch to light mode
plugins:
- search:
lang: en
features:
- navigation.footer
- content.code.copy
- content.code.select
- content.action.edit
- content.action.view
logo: assets/logo.png
favicon: assets/favicon.png
# add repository
repo_url: https://github.com/keanteng/blueautomata
repo_name: keanteng/blueautomata
# copyright
copyright: BlueAutomata © 2023 Kean Teng
# social links
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/keanteng
- icon: fontawesome/brands/medium
link: https://khorkeanteng.medium.com
- icon: fontawesome/brands/linkedin
link: https://my.linkedin.com/in/khorkeanteng
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/khorkeanteng/
- icon: fontawesome/brands/twitter
link: https://twitter.com/realKeanTeng
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# plugins for jupyter notebook (might slow down site launch)
plugins:
- search
- git-revision-date
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- mkdocs-jupyter:
include_source: True
ignore_h1_titles: True
allow_errors: false
ignore: ["conf.py"]
execute: False
execute_ignore: ["notebooks/*.ipynb", "workshops/*.ipynb"]