ddeutil-workflow/mkdocs.yml at main · ddeutils/ddeutil-workflow · 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
site_name: Workflow
theme:
  name: material
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.action.edit
    - content.tooltips
    - header.autohide
    - navigation.indexes
    - navigation.expand
    - navigation.footer
    - navigation.instant
    - navigation.sections
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.path
    - navigation.prune
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  language: en
  palette:
    - scheme: default
      primary: white
      accent: gray
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: grey
      accent: white
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  font:
    text: "Public Sans"
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github-alt
    admonition:
        warning: material/alert-decagram-outline

repo_name: ddeutils/ddeutil-workflow
repo_url: https://github.com/ddeutils/ddeutil-workflow

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/ddeutils/ddeutil-workflow
    - icon: fontawesome/brands/linkedin-in
      link: https://www.linkedin.com/in/korawica
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/korawica

nav:
  - Home:
    - index.md
    - Get Started: getting-started.md
    - Configuration: configuration.md
    - Context: context.md
  - API references:
    - Library:
      - Stages: api/stages.md
      - Event: api/event.md
      - Job: api/job.md
      - Workflow: api/workflow.md
      - Params: api/params.md
      - Result: api/result.md
      - Reusables: api/reusables.md
      - Traces: api/traces.md
      - Audits: api/audits.md
      - Utils: api/utils.md
      - Errors: api/errors.md
  - Examples:
      - RestAPI: examples/api.md
      - Postgres: examples/pg.md

plugins:
  - tags
  - search

markdown_extensions:
  - attr_list
  - md_in_html
  - def_list
  - admonition
  - footnotes
  - tables
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

copyright: |
  Copyright &copy; 2024 <a href="https://github.com/ddeutils/ddeutil-workflow" target="_blank" rel="noopener">DDEUtils Organization</a>