forked from boozallen/sdp-libraries
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
78 lines (71 loc) · 1.87 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
site_name: Solutions Delivery Platform
theme:
name: material
palette:
primary: navy
features:
- navigation.instant
- navigation.tabs
- navigation.sections
- navigation.top
logo: assets/images/jte.svg
favicon: assets/images/jte.svg
## this is a hack
## we add the libraries dir as a custom dir for the theme so that
## we get live reloading of the docs site via `just serve` by passing
## --watch-theme to the `mkdocs serve` command
custom_dir: libraries/
repo_url: https://github.com/boozallen/sdp-libraries
plugins:
- search
- awesome-pages
- gen-files:
scripts:
- resources/docs/copy_docs.py
- resources/docs/add_glossary.py
extra_css:
- css/extra.css
extra:
version:
provider: mike
default: latest
social:
- icon: fontawesome/brands/github
link: https://github.com/boozallen/sdp-libraries.git
markdown_extensions:
- admonition
- abbr
- footnotes
- attr_list
- pymdownx.tabbed
- pymdownx.highlight
- pymdownx.superfences
- toc:
permalink: true
- pymdownx.snippets:
base_path: "docs"
- pymdownx.betterem:
smart_enable: all
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
nav:
- Home: 'index.md'
- Concepts:
- 'concepts/overview.md'
- Unit Testing:
- 'concepts/unit-testing/index.md'
- 'concepts/unit-testing/jenkins-spock.md'
- 'concepts/unit-testing/writing-tests.md'
- 'concepts/unit-testing/executing-tests.md'
- 'concepts/unit-testing/faq.md'
- Tutorials:
- 'tutorials/overview.md'
- How-To Guides:
- 'how-to/overview.md'
# navigation for Libraries section is driven by the gen_scripts and awesome-pages plugins
# see: /resources/docs/copy_docs.py
- ... | glob=libraries/**
- Contributing:
- 'contributing/index.md'
- 'contributing/create-new-library.md'