1# NOTE: the mkdocs dependencies will need to be installed out of
2# band until this whole thing gets more automated:
3#
4# pip install -r mkdocs-reqs.txt
5#
6
7site_name: urfave/cli
8site_url: https://cli.urfave.org/
9repo_url: https://github.com/urfave/cli
10edit_uri: edit/main/docs/
11nav:
12 - Home:
13 - Welcome: index.md
14 - Contributing: CONTRIBUTING.md
15 - Code of Conduct: CODE_OF_CONDUCT.md
16 - Releasing: RELEASING.md
17 - Security: SECURITY.md
18 - Migrate v1 to v2: migrate-v1-to-v2.md
19 - v2 Manual:
20 - Getting Started: v2/getting-started.md
21 - Migrating From Older Releases: v2/migrating-from-older-releases.md
22 - Examples:
23 - Greet: v2/examples/greet.md
24 - Arguments: v2/examples/arguments.md
25 - Flags: v2/examples/flags.md
26 - Subcommands: v2/examples/subcommands.md
27 - Subcommands Categories: v2/examples/subcommands-categories.md
28 - Exit Codes: v2/examples/exit-codes.md
29 - Combining Short Options: v2/examples/combining-short-options.md
30 - Bash Completions: v2/examples/bash-completions.md
31 - Generated Help Text: v2/examples/generated-help-text.md
32 - Version Flag: v2/examples/version-flag.md
33 - Timestamp Flag: v2/examples/timestamp-flag.md
34 - Suggestions: v2/examples/suggestions.md
35 - Full API Example: v2/examples/full-api-example.md
36 - v1 Manual:
37 - Getting Started: v1/getting-started.md
38 - Migrating to v2: v1/migrating-to-v2.md
39 - Examples:
40 - Greet: v1/examples/greet.md
41 - Arguments: v1/examples/arguments.md
42 - Flags: v1/examples/flags.md
43 - Subcommands: v1/examples/subcommands.md
44 - Subcommands (Categories): v1/examples/subcommands-categories.md
45 - Exit Codes: v1/examples/exit-codes.md
46 - Combining Short Options: v1/examples/combining-short-options.md
47 - Bash Completions: v1/examples/bash-completions.md
48 - Generated Help Text: v1/examples/generated-help-text.md
49 - Version Flag: v1/examples/version-flag.md
50
51theme:
52 name: material
53 palette:
54 - media: "(prefers-color-scheme: light)"
55 scheme: default
56 toggle:
57 icon: material/brightness-4
58 name: dark mode
59 - media: "(prefers-color-scheme: dark)"
60 scheme: slate
61 toggle:
62 icon: material/brightness-7
63 name: light mode
64 features:
65 - content.code.annotate
66 - navigation.top
67 - navigation.instant
68 - navigation.expand
69 - navigation.sections
70 - navigation.tabs
71 - navigation.tabs.sticky
72plugins:
73 - git-revision-date-localized
74 - search
75 - tags
76# NOTE: this is the recommended configuration from
77# https://squidfunk.github.io/mkdocs-material/setup/extensions/#recommended-configuration
78markdown_extensions:
79 - abbr
80 - admonition
81 - attr_list
82 - def_list
83 - footnotes
84 - meta
85 - md_in_html
86 - toc:
87 permalink: true
88 - pymdownx.arithmatex:
89 generic: true
90 - pymdownx.betterem:
91 smart_enable: all
92 - pymdownx.caret
93 - pymdownx.details
94 - pymdownx.emoji:
95 emoji_index: !!python/name:materialx.emoji.twemoji
96 emoji_generator: !!python/name:materialx.emoji.to_svg
97 - pymdownx.highlight
98 - pymdownx.inlinehilite
99 - pymdownx.keys
100 - pymdownx.mark
101 - pymdownx.smartsymbols
102 - pymdownx.superfences
103 - pymdownx.tabbed:
104 alternate_style: true
105 - pymdownx.tasklist:
106 custom_checkbox: true
107 - pymdownx.tilde
View as plain text