-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdocs.yml
71 lines (61 loc) · 1.72 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
site_name: KlongPy
site_url: https://your-site-url.com
# Define the source directory for Markdown files
docs_dir: 'docs'
# Define the directory for the built HTML files
site_dir: 'site'
# Specify any extra files to include in the built site
# like 'robots.txt' or 'favicon.ico'
extra_files:
- 'robots.txt'
# Navigation structure
nav:
- Home: 'index.md'
- Quick Start: 'quick-start.md'
- Examples: 'examples.md'
- Guides:
- Overview: 'overview.md'
- Installation: 'installation.md'
- Reference:
- Language Reference: 'language-reference.md'
- REPL: 'repl.md'
- Status: 'status.md'
- Differences from Klong: 'differences-from-klong.md'
- Additional Resources:
- Related Projects: 'related-projects.md'
- Contributing: 'contribute.md'
- Acknowledgements: 'acknowledgement.md'
# Theme configuration
theme:
name: 'material' # or 'mkdocs' for the default theme
# Specify theme customizations such as colors and logo
logo: 'assets/images/klongpy_logo.jpg'
favicon: 'assets/images/favicon.ico'
# Customization of the theme's colors and fonts
palette:
primary: 'indigo'
accent: 'indigo'
font:
text: 'Roboto'
code: 'Roboto Mono'
# Plugins configuration (if any plugins are used)
plugins:
- search
- minify:
minify_html: true
# Extensions configuration (if any Markdown extensions are used)
markdown_extensions:
- toc:
permalink: true
- admonition
- codehilite:
guess_lang: false
# Specify custom CSS and JavaScript if you have any
extra_css:
- 'assets/css/custom.css'
extra_javascript:
- 'assets/js/custom.js'
# Google Analytics or other tracking (if you want to add tracking)
# google_analytics:
# - 'UA-XXXXX-X'
# - 'auto'