forked from block/goose
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
143 lines (142 loc) · 3.76 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
site_name: Goose Documentation
site_author: Block
site_description: Documentation for Goose
repo_url: https://github.com/block/goose
repo_name: "block/goose"
edit_uri: "https://github.com/block/goose/blob/main/docs/"
site_url: "https://block.github.io/goose/"
use_directory_urls: false
# theme
theme:
name: material
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- content.tabs.link
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.top
- navigation.tracking
- navigation.expand
- search.share
- search.suggest
- toc.follow
palette:
- scheme: slate
primary: black
accent: indigo
logo: assets/logo.png
font:
text: Roboto
code: Roboto Mono
favicon: assets/logo.ico
icon:
logo: assets/logo.ico
# plugins
plugins:
- blog:
archive: false
categories: false
blog_toc: true
- include-markdown
- callouts
- glightbox
- mkdocstrings:
handlers:
python:
paths: [src]
setup_commands:
- "import sys; sys.path.append('src')" # Add src folder to Python path
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- redirects:
redirect_maps:
- git-committers: # Show git committers
branch: main
enabled: !ENV [ENV_PROD, false]
repository: block/goose
- git-revision-date-localized: # Show git revision date
enable_creation_date: true
enabled: !ENV [ENV_PROD, false]
extra:
annotate:
json:
- .s2
social: []
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- nl2br # Newline to <br> (like GitHub)
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: false
- pymdownx.mark
- pymdownx.smartsymbols
- 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
- toc:
permalink: true
nav:
- Home: index.md
- "Installation": installation.md
- "Quickstart": quickstart.md
- "Contributing": contributing.md
- Guides:
- "Getting Started": guidance/getting-started.md
- "Managing Goose Sessions": guidance/managing-goose-sessions.md
- "Quick Tips": guidance/tips.md
- "Using Goosehints": guidance/using-goosehints.md
- "Applications of Goose": guidance/applications.md
- "Goose in Action": guidance/goose-in-action.md
- Plugins:
- "Overview": plugins/plugins.md
- Toolkits:
- "Using Toolkits": plugins/using-toolkits.md
- "Creating a New Toolkit": plugins/creating-a-new-toolkit.md
- "Available Toolkits": plugins/available-toolkits.md
- CLI Commands:
- "Available CLI Commands": plugins/cli.md
- Providers:
- "Available Providers": plugins/providers.md
- Advanced:
- Configuration: configuration.md
- "Reference":
- "API Docs": reference/index.md
- Blog:
- "Blog Home": blog/index.md