-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
101 lines (91 loc) · 2.6 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
site_name: Prompt Templates
site_description: A library for working with prompt templates locally or on the Hugging Face Hub
site_url: https://moritzlaurer.github.io/prompt_templates/
repo_url: https://github.com/MoritzLaurer/prompt_templates
repo_name: moritzlaurer/prompt_templates
nav:
- Home:
- Overview: index.md
- Standard Prompt Format: standard_prompt_format.md
- HF Hub Repo Types: repo_types_examples.md
#- Tools: standard_tool_format.md
#- Agents: agents.md
- API Reference:
- Downloading prompts and tools: reference/loaders.md
- Prompt templates: reference/prompt_templates.md
- Populated prompt: reference/populated_prompt.md
#- Tools: reference/tools.md
theme:
name: material
features:
- navigation.tabs
- navigation.sections
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
- content.code.strip_repl_prompts # feature does not exist?
- navigation.footer
- navigation.instant
- navigation.tracking
- toc.follow
- header.autohide
# Update color scheme to match HF style
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode - matches HF's dark theme
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
icon:
repo: fontawesome/brands/github
extra_css:
- stylesheets/extra.css
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/MoritzLaurer/prompt_templates
- icon: fontawesome/brands/python
link: https://pypi.org/project/prompt-templates/
markdown_extensions:
- pymdownx.highlight:
use_pygments: true
anchor_linenums: true
- pymdownx.superfences
- pymdownx.inlinehilite
- admonition
- pymdownx.details
plugins:
- search
- autorefs
- mkdocstrings:
default_handler: python
handlers:
python:
options:
docstring_style: google
show_source: true
show_root_heading: true
show_object_full_path: false
heading_level: 2
members_order: source
separate_signature: true
filters: ["!^_[^_]"]
docstring_section_style: table
render_plugin: "autorefs"
extra_javascript:
- javascripts/strip_repl.js