docs-bash-task-master/mkdocs.yml at master · hppr-dev/docs-bash-task-master · GitHub

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
site_name: Bash Task Master
site_description: 'Bash Task Master Documentation'
site_author: 'Stephen Walker'
site_url: 'https://bash-task-master.readthedocs.io'

copyright: |
  &copy; hppr.dev

docs_dir: docs/

repo_name: hppr-dev/bash-task-master
repo_url: https://github.com/hppr-dev/bash-task-master
edit_uri: https://github.com/hppr-dev/docs-bash-task-master/blob/master/docs

nav:
  - Introduction: index.md
  - Walkthrough: walkthrough.md
  - Built In Tasks: built_in_tasks.md
  - Task Files: task_files.md
  - State: state.md
  - Modules: modules.md
  - Drivers: drivers.md
  - Repositories: repositories.md

theme:

  name: 'material'
  #custom_dir: 'theme'
  favicon: 'assets/favicon.svg'
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: 'blue grey'
      accent: 'deep purple'
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: 'indigo'
      accent: 'deep purple'
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

  font:
    text: 'Roboto'
    code: 'Roboto Mono'

  #language: 'en'
  #direction: 'ltr'

  features:

  # Announce
  #
  #- announce.dismiss # Adds a "X" button to dismiss a news banner/mark it as read.*

  # Header
  #
  - header.autohide # Hide header when user scrolls past a specific point.

  # Navigation:
  #
  - navigation.expand      # Expand all collapsable sections.
  #- navigation.instant     # Instant loading pages.
  #- navigation.indexes     # Attach pages directly to Sections. Incompatible with "toc.integrate"
  #- navigation.sections    # Render top sections as groups.
  - navigation.tabs         # Render top sections as tabs at the top.
  - navigation.tabs.sticky # Tabs won't disappear when scrolling down. Requires "navigation.tabs".
  - navigation.top         # Adds a "Back to top" that is shown when scrolling up.
  #- navigation.tracking    # Updates the url with highlighted section anchor.

  # Search
  #
  #- search.highlight # Search will highlight the searched word(s) on the page.*
  #- search.share     # Adds an option to share a search query link.*
  #- search.suggest   # Search will suggest the likeliest completion for a word.*

  # Table of Contents
  #
  - toc.integrate          # Include the TOC sections in the left navugation.

  # Code copy
  - content.code.copy

  icon:
    logo: 'material/format-list-group'
    repo: 'material/git'

#extra_css:
#  - stylesheets/extra.css

#extra_javascript:

extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/hppr-dev/bash-task-master'

  # Hide the "Made with Material for MkDocs" text in the footer of the pages by setting
  #generator: true

markdown_extensions:
  - markdown.extensions.admonition:
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.toc:
      permalink: true
  #- pymdownx.arithmex:
  #- pymdownx.b64:
  #- pymdownx.betterem:
  #- pymdownx.caret:
  #- pymdownx.critic:
  #- pymdownx.details:
  #- pymdownx.emoji:
  #- pymdownx.escapeall:
  #- pymdownx.extra:
  #- pymdownx.extrarawhtml:
  #- pymdownx.highlight:
  #- pymdownx.inlinehilite:
  #- pymdownx.keys:
  #- pymdownx.magiclink:
  #- pymdownx.mark:
  #- pymdownx.pathconverter:
  #- pymdownx.progressbar:
  #- pymdownx.smartsymbols:
  #- pymdownx.snippets:
  #- pymdownx.striphtml:
  - pymdownx.superfences:
  #- pymdownx.tabbed:
  #- pymdownx.tasklist:
  #- pymdownx.tilde: