-
Notifications
You must be signed in to change notification settings - Fork 63
Expand file tree
/
Copy pathmkdocs.yml
More file actions
53 lines (47 loc) · 1.58 KB
/
mkdocs.yml
File metadata and controls
53 lines (47 loc) · 1.58 KB
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
site_name: SuperDiff Documentation
site_description: User- and contributor-facing documentation for SuperDiff
copyright: ©️ Elliot Winkler; Splitwise, Inc.
# NOTE: Don't do this for now as it loads the version and stars dynamically
#repo_url: https://github.com/splitwise/super_diff
#repo_name: SuperDiff on GitHub
theme:
name: material
features:
- navigation.instant
- navigation.instant.progress
- navigation.tabs
- navigation.tabs.sticky
- navigation.path
- toc.integrate
#plugins:
#- search
nav:
- Home: index.md
- User Documentation:
- "Introduction to SuperDiff": "users/index.md"
- "Getting Started": "users/getting-started.md"
- "Customizing SuperDiff": "users/customization.md"
- Contributor Documentation:
- "Home": "contributors/index.md"
- "How to Contribute": "contributors/how-to-contribute.md"
- Architecture:
- "Introduction": "contributors/architecture/introduction.md"
- "How RSpec works": "contributors/architecture/how-rspec-works.md"
- "How SuperDiff works": "contributors/architecture/how-super-diff-works.md"
- "Structure": "contributors/architecture/structure.md"
#plugins:
#- entangled # this also runs `entangled sync` as a pre-build action
extra_css:
- stylesheets/extra.css
markdown_extensions:
- admonition
- def_list
- footnotes
- smarty
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true