-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdocs.yml
78 lines (70 loc) · 2.09 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
# This file configures the documentation site
site_name: nhs-number
repo_url: https://github.com/uk-fci/nhs-number
repo_name: uk-fci/nhs-number
copyright: Copyright © 2021-2023 Andy Law, The University of Edinburgh, and the Faculty of Clinical Informatics
# explicitly defines the Nav so we can set order of pages other than default alphabetical
nav:
- Introduction:
- "index.md"
- About NHS Numbers: "nhs-numbers.md"
- Getting Started:
- Installation: "installation.md"
- Usage: "usage.md"
- Developer Guide:
- Project Structure: "developing.md"
- Documentation: 'documentation.md'
- Useful URLs: "useful_urls.md"
- Contributors: "contributors.md"
- Changelog: "changelog.md"
# footer links and variables
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/ukfci
- icon: fontawesome/brands/github
link: https://github.com/uk-fci
# theme and mkdocs additional features
theme:
name: material
icon:
logo: material/check-all
favicon: _assets/_images/done_all.svg
custom_dir: 'overrides'
features:
- content.action.edit # explicitly adds edit button (Material4MkDocs9.0)
- content.action.view # explicitly adds view button (Material4MkDocs9.0)
- content.code.copy
- content.code.select
- content.code.annotate
- navigation.expand
- navigation.footer # explicitly adds footer prev/next (Material4MkDocs9.0)
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- toc.follow
watch:
- overrides
extra_css:
- _assets/_stylesheets/extra.css
# markdown additional features
markdown_extensions:
- admonition
- attr_list
- md_in_html
- 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.superfences
- pymdownx.snippets:
check_paths: true
- toc:
permalink: false