FilesExpand file tree

master

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

153 lines (143 loc) · 3.9 KB

master

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

153 lines (143 loc) · 3.9 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

site_name: Taskfile Help

site_description: Dynamic Taskfile help generator

site_url: https://royw.github.io/taskfile_help

repo_url: https://github.com/royw/taskfile_help

repo_name: royw/taskfile_help

copyright: Copyright © 2025 Roy Wright

theme:

name: material

features:

- navigation.instant

- navigation.tracking

- navigation.tabs

- navigation.tabs.sticky

- navigation.sections

- navigation.expand

- navigation.path

- navigation.indexes

- navigation.prune

- toc.follow

- navigation.top

- search.suggest

- search.highlight

- content.tabs.link

- content.code.annotation

- content.code.copy

- header.autohide

language: en

palette:

# Palette toggle for light mode

- media: "(prefers-color-scheme: light)"

scheme: default

primary: blue

accent: blue

toggle:

icon: material/brightness-7

name: Switch to dark mode

# Palette toggle for dark mode

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: blue

accent: blue

toggle:

icon: material/brightness-4

name: Switch to light mode

icon:

repo: fontawesome/brands/github

logo: material/home

favicon: data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 24 24%22><path d=%22M10,20V14H14V20H19V12H22L12,3L2,12H5V20H10Z%22/></svg>

plugins:

- search:

separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

- git-revision-date-localized:

type: timeago

timezone: America/Chicago

locale: en

fallback_to_build_date: true

- autorefs

- gen-files:

scripts:

- docs/gen_ref_pages.py

- literate-nav:

nav_file: SUMMARY.md

- mermaid2

- mkdocstrings:

default_handler: python

handlers:

python:

paths: [src]

options:

docstring_style: google

docstring_options:

ignore_init_summary: true

merge_init_into_class: true

show_submodules: false

show_source: true

show_bases: false

show_root_heading: true

show_root_full_path: true

show_if_no_docstring: true

filters: ["!^_"]

show_root_toc_entry: false

heading_level: 2

markdown_extensions:

- pymdownx.highlight:

default_lang: python

use_pygments: true

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.snippets

- admonition

- pymdownx.arithmatex:

generic: true

- footnotes

- pymdownx.details

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.mark

- attr_list

- md_in_html

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

- def_list

- pymdownx.tasklist:

custom_checkbox: true

- pymdownx.tabbed:

alternate_style: true

- tables

- toc:

permalink: true

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/royw

name: Roy Wright on GitHub

generator: false

extra_css:

- stylesheets/extra.css

extra_javascript:

- javascripts/extra.js

nav:

- Home: index.md

- Getting Started:

- Installation: setup/installation.md

- Quick Start: setup/quickstart.md

- Configuration: setup/configuration.md

- Completion: setup/completion.md

- Development:

- Architecture: development/architecture.md

- Development Guide: development/guide.md

- Git Hooks: githooks.md

- Testing: development/testing.md

- Test Documentation: tests.md

- Release Process: development/releasing.md

- Contributing: development/contributing.md

- Reference: reference/

watch:

- src/taskfile_help