-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmkdocs.yml
214 lines (205 loc) · 7.02 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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
site_name: Colorist for Python 🌈
site_url: https://jakob-bagterp.github.io/colorist-for-python/
site_description: Lightweight Python package that makes it easy and fast to print colored text in the terminal
site_author: Jakob Bagterp
copyright: Copyright © 2022 - 2024, Jakob Bagterp. All Rights Reserved.
repo_url: https://github.com/jakob-bagterp/colorist-for-python
nav:
- Home:
- index.md
- Project:
- Donate: project/donate.md
- Support and Contribution: project/support-and-contribution.md
- License 🔗: https://github.com/jakob-bagterp/colorist-for-python/blob/master/LICENSE.md
- Release Notes 🔗: https://github.com/jakob-bagterp/colorist-for-python/releases
- Source Code 🔗: https://github.com/jakob-bagterp/colorist-for-python
- Index:
- Tags: index/tags.md
- Getting Started:
- getting-started/index.md
- Installation: getting-started/installation.md
- User Guide:
- user-guide/index.md
- Standard Colors:
- Text: user-guide/standard-colors/text-foreground.md
- Background: user-guide/standard-colors/background.md
- Normal and Bright Palette: user-guide/standard-colors/normal-and-bright-palette.md
- Effects and Styling: user-guide/effects-and-styling.md
- Extended Colors:
- VGA: user-guide/extended-colors/vga.md
- RGB: user-guide/extended-colors/rgb.md
- HSL: user-guide/extended-colors/hsl.md
- Hex: user-guide/extended-colors/hex.md
- Compatibility:
- Backwards Compatible String Formats: user-guide/compatibility/backwards-compatible-string-formats.md
- Supported Colors and Styles by Terminals: user-guide/compatibility/terminal-support.md
- Reference:
- reference/index.md
- Text Colors:
- Full Line: reference/text-colors/full-line.md
- Mixed: reference/text-colors/mixed.md
- Background Colors:
- Full Line: reference/background-colors/full-line.md
- Mixed: reference/background-colors/mixed.md
- Effects and Styling:
- Full Line: reference/effects-and-styling/full-line.md
- Mixed: reference/effects-and-styling/mixed.md
- Extended Colors:
- VGA: reference/extended-colors/vga.md
- RGB: reference/extended-colors/rgb.md
- HSL: reference/extended-colors/hsl.md
- Hex: reference/extended-colors/hex.md
- ANSI Escape Codes:
- ansi-escape-codes/index.md
- Introduction: ansi-escape-codes/introduction.md
- Standard 16 Colors: ansi-escape-codes/standard-16-colors.md
- Extended 256 Colors: ansi-escape-codes/extended-256-colors.md
- RGB Colors: ansi-escape-codes/rgb-colors.md
- Effects: ansi-escape-codes/effects.md
theme:
name: material
custom_dir: docs/assets/overrides
features:
- search.suggest
- search.highlight
- navigation.footer
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.top
- navigation.path
- navigation.indexes
- content.code.copy
- content.code.select
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: purple
accent: purple
toggle:
icon: material/eye
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: purple
accent: purple
toggle:
icon: material/eye-outline
name: Switch to light mode
markdown_extensions:
- toc:
permalink: "#"
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
use_pygments: true
pygments_lang_class: true
auto_title: true
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.snippets
- pymdownx.superfences
- admonition
- attr_list
- footnotes
- tables
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
social:
- icon: fontawesome/brands/github
name: Colorist for Python on GitHub
link: https://github.com/jakob-bagterp/colorist-for-python
- icon: fontawesome/brands/linkedin
name: Jakob Bagterp on LinkedIn
link: https://www.linkedin.com/in/jakobbagterp/
- icon: fontawesome/brands/instagram
name: Jakob Bagterp on Instagram
link: https://www.instagram.com/bagterp_photography/
analytics:
provider: google
property: G-0BNHYMBHHK
feedback:
title: Was this page helpful?
ratings:
- icon: material/thumb-up-outline
name: This page was helpful
data: 1
note: >-
Thank you for your feedback!
- icon: material/thumb-down-outline
name: This page could be improved
data: 0
note: >-
Thank you for your feedback! Help us improve this page by using our
<a href="https://github.com/jakob-bagterp/colorist-for-python/issues/new/?title=[Feedback]+{title}+-+{url}"
target="_blank" rel="noopener">
feedback form</a>.
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
version:
provider: mike
extra_css:
- assets/stylesheets/colors.css
- assets/stylesheets/effects.css
- assets/stylesheets/tables.css
extra_javascript:
- assets/scripts/text-contrast.js
plugins:
- search:
lang: en
- tags
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [src]
options:
docstring_style: google
show_source: false
show_bases: false
heading_level: 2
show_category_heading: true
show_root_toc_entry: false
show_symbol_type_heading: true
show_symbol_type_toc: true
merge_init_into_class: true
- git-revision-date-localized:
enabled: true
type: timeago
enable_creation_date: true
fallback_to_build_date: true
- minify:
minify_html: true
minify_js: true
minify_css: true
htmlmin_opts:
remove_comments: true
js_files:
- js/timeago_mkdocs_material.js
css_files:
- css/timeago.css
- assets/_mkdocstrings.css
- redirects:
redirect_maps:
user-guide/materials/ansi-escape-codes.md: ansi-escape-codes/index.md
donate.md: project/donate.md
support-and-contribution.md: project/support-and-contribution.md
tags.md: index/tags.md
user-guide/materials/other-string-formats.md: user-guide/compatibility/backwards-compatible-string-formats.md
user-guide/materials/terminal-support.md: user-guide/compatibility/terminal-support.md
watch:
- src
dev_addr: 127.0.0.1:8002