-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
129 lines (120 loc) · 3.89 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
129
site_name: MemXTerminator Wiki
repo_url: https://github.com/ZhenHuangLab/MemXTerminator
repo_name: MemXTerminator
site_description: A simple and beautiful wiki for MemXTerminator
site_author: Zhen Huang
theme:
name: material
custom_dir: ./wiki/overrides
language: en
favicon: assets/icons/favicon.svg
icon:
logo: simple/gitbook
font:
text: "Roboto Slab"
code: "Roboto Mono"
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to dark mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to system preference
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.instant
- navigation.instant.progress
- navigation.path
- navigation.indexes
- navigation.footer
- announce.dismiss
- toc.follow
- content.code.copy
- content.code.annotate
- navigation.top
- search.suggest
- search.highlight
- search.share
docs_dir: ./wiki/docs
site_dir: ./wiki/site
plugins:
- search
- mkdocs-jupyter:
include_source: True
kernel_name: python3
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra_javascript:
- javascripts/mathjax.js
- javascripts/katex.js
- javascripts/extra.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
- stylesheets/extra.css
nav:
- Home: index.md
- Installation: ./tutorials/installation.md
- Usage: ./tutorials/usage.md
- Tutorials:
- "Basic pipeline": ./tutorials/basic-pipeline.md
- "Preprocessing": ./tutorials/preprocessing.md
- Radonfit:
- ./tutorials/radonfit-tutorials/index.md
- Particle Membrane Analysis: ./tutorials/radonfit-tutorials/radonfit-mem-analysis.md
- Particle Membrane Subtraction: ./tutorials/radonfit-tutorials/radonfit-particle-mem-subtraction.md
# - Micrograph Membrane Subtraction: ./tutorials/radonfit-tutorials/radonfit-mms.md
- Bezierfit:
- ./tutorials/bezierfit-tutorials/index.md
- Particle Membrane Analysis: ./tutorials/bezierfit-tutorials/bezierfit-mem-analysis.md
- Particle Membrane Subtraction: ./tutorials/bezierfit-tutorials/bezierfit-particle-mem-subtraction.md
# - Micrograph Membrane Subtraction: ./tutorials/bezierfit-tutorials/bezierfit-mms.md
- Micrograph Membrane Subtraction: ./tutorials/micrograph-membrane-subtraction.md
- Frequently Asked Questions: ./tutorials/faq.md
- Reference Pages:
- "Visualize Radonfit (.ipynb)": ./tutorials/reference/radonfit-mem-analysis-visualizer.ipynb
- "Visualize Bezierfit (.ipynb)": ./tutorials/reference/bezierfit-mem-analysis-visualizer.ipynb
- "Conventions": ./tutorials/reference/conventions.md
- "API Reference": ./tutorials/reference/api.md