-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
120 lines (112 loc) · 2.65 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
# https://www.mkdocs.org
# Project
site_name: django-user-trace
site_author: Jonathan Hiles
site_description: A Python logging filter for Django user attributes
# Copyright
copyright: Copyright © 2023 Jonathan Hiles
# Repository
repo_name: axieum/django-user-trace
repo_url: https://github.com/axieum/django-user-trace
edit_uri: blob/main/docs/
# Theme
theme:
name: material
features:
- content.action.edit
- content.code.annotate
- content.code.copy
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.path
- navigation.sections
- navigation.top
- navigation.tracking
- toc.follow
icon:
edit: octicons/file-code-24
palette:
# Light mode
- media: '(prefers-color-scheme: light)'
scheme: default
primary: blue
accent: blue
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: black
accent: blue
toggle:
icon: material/weather-night
name: Switch to light mode
# Customisation
extra:
social:
- icon: fontawesome/brands/python
link: https://pypi.org/project/django-user-trace
- icon: fontawesome/brands/github
link: https://github.com/axieum
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/in/jonathan-hiles
- icon: fontawesome/solid/envelope
link: mailto:[email protected]
name: [email protected]
version:
provider: mike
# Watch
watch:
- CHANGELOG.md
- CONTRIBUTING.md
- README.md
- SECURITY.md
# Plugins
plugins:
- awesome-pages:
filename: .pages.yml
- gen-files:
scripts:
- docs/changelog/index.py
- git-revision-date-localized:
enable_creation_date: true
fallback_to_build_date: true
type: timeago
- minify:
minify_html: true
- search
# Markdown
markdown_extensions:
- abbr
- admonition
- attr_list
- footnotes
- md_in_html
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.snippets
- 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
- tables
- toc:
permalink: '#'