-
Notifications
You must be signed in to change notification settings - Fork 188
/
mkdocs.yml
132 lines (125 loc) · 3.7 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
# Project information
site_name: 'AutoConnect for ESP8266/ESP32'
site_description: 'ESP8266/ESP32 WLAN configuration at run time with web interface'
site_author: 'Hieromon Ikasamo'
site_url: 'https://Hieromon.github.io/AutoConnect/'
# Docs
docs_dir: 'mkdocs'
# Pages
nav:
- 'Overview' : index.md
- 'Getting started' : gettingstarted.md
- 'AutoConnect menu' : menu.md
- 'Basic usage' : basicusage.md
- 'Advanced usage' :
- 'Advanced usage' : advancedusage.md
- 'AutoConnect WiFi connection control' : adconnection.md
- 'Captive portal control' : adcpcontrol.md
- 'Settings and controls for network and WiFi' : adnetwork.md
- 'Authentication settings' : adauthentication.md
- 'Credential accesses' : adcredential.md
- 'Customizing page appearance' : adexterior.md
- 'Other operation settings and controls' : adothers.md
- 'Custom Web pages' :
- 'Custom Web pages with AutoConnect' : acintro.md
- 'AutoConnectElements' : acelements.md
- 'Custom Web pages with JSON' : acjson.md
- 'Handling the custom Web pages' : achandling.md
- 'Interact between Sketch and AutoConnectElements' : acinteract.md
- 'OTA Updates' :
- 'OTA Updates' : otaupdate.md
- 'OTA via Web Browser' : otabrowser.md
- 'OTA using Update Server' : otaserver.md
- 'Using Filesystem' : filesystem.md
- 'Library APIs' :
- 'AutoConnect API': api.md
- 'AutoConnectAux API': apiaux.md
- 'AutoConnectConfig API': apiconfig.md
- 'AutoConnectElements API': apielements.md
- 'AutoConnectUpdate API' : apiupdate.md
- 'Something extra': apiextra.md
- 'Examples' :
- 'How to embed': howtoembed.md
- 'Tips for data conversion': datatips.md
- 'Attach the menus': menuize.md
- 'Custom Web pages w/o JSON': wojson.md
- 'Works with ESP32-CAM': esp32cam.md
- 'Appendix':
- 'Inside AutoConnect::begin': lsbegin.md
- 'Saved credentials access': credit.md
- 'File upload handler': acupload.md
- 'Custom colorized': colorized.md
- 'Change label text': changelabel.md
- 'FAQ' : faq.md
- 'Change log' : changelog.md
- 'License' : license.md
# Repository
repo_name: Hieromon/AutoConnect
repo_url: https://github.com/Hieromon/AutoConnect
edit_uri: ""
# Copyright
copyright: Copyright © 2018-2023 Hieromon Ikasamo
# Configuration
use_directory_urls: false
theme:
name: material
language: en
logo: images/arduino-logo.svg
icon:
logo: logo
palette:
primary: indigo
accent: indigo
font:
text: Roboto
code: Roboto Mono
features:
- navigation.top
# Customization
extra_css:
- css/paragraph.css
- css/extra.css
- https://use.fontawesome.com/releases/v5.14.0/css/all.css
extra_javascript:
- js/gifffer.min.js
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Hieromon
- icon: fontawesome/brands/twitter
link: https://twitter.com/hieromon
analytics:
provider: google
property: !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
# Extensions
markdown_extensions:
- admonition
- attr_list
- def_list
- fontawesome_markdown
- footnotes
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
guess_lang: false
linenums: none
use_pygments: true
noclasses: true
pygments_style: monokai
- pymdownx.inlinehilite
- pymdownx.magiclink:
repo_url_shorthand: true
user: Hieromon
repo: AutoConnect
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist
- toc:
permalink: true