-
Notifications
You must be signed in to change notification settings - Fork 10
/
mkdocs.yml
198 lines (180 loc) · 6.45 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
# Copyright (c) 2020 makerdiary.com
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# Project information
site_name: nRF52840 M.2 Developer Kit
site_description: >-
The documentation offers all you need to start developing with nRF52840 M.2 Developer Kit.
site_author: makerdiary
site_url: https://wiki.makerdiary.com/nrf52840-m2-devkit/
# Repository
repo_name: makerdiary/nrf52840-m2-devkit
repo_url: https://github.com/makerdiary/nrf52840-m2-devkit
edit_uri: ""
# Copyright
copyright: 'Copyright © 2020 <a href="https://wiki.makerdiary.com" target="_blank">wiki.makerdiary.com</a>'
# Configuration
theme:
name: null
custom_dir: mkdocs-material/material
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
- tabs
#- instant
palette:
scheme: default
primary: red-bud
accent: red-bud
font:
text: Roboto
code: Roboto Mono
icon:
logo: logo
favicon: assets/images/favicon.png
# Plugins
plugins:
- search
- minify:
minify_html: true
# Customization
extra:
social:
- icon: fontawesome/brands/shopify
link: https://store.makerdiary.com
- icon: fontawesome/brands/github
link: https://github.com/makerdiary
- icon: fontawesome/brands/twitter
link: https://twitter.com/makerdiary
- icon: fontawesome/brands/discourse
link: https://community.makerdiary.com
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UCX4nJNlsyj9VJeQOHgOs0yg
- icon: fontawesome/brands/medium
link: https://medium.com/makerdiary
- icon: fontawesome/brands/zhihu
link: https://zhuanlan.zhihu.com/makerdiary
# disqus: 'makerdiary'
# discourse: 'community.makerdiary.com’
# Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.attr_list
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
permalink: true
- pymdownx.arithmatex
- 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:
# linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: makerdiary
repo: nrf52840-m2-devkit
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page tree
nav:
- Introduction: index.md
- Getting Started: getting-started.md
- Programming: programming.md
- Power Profiling: power-profiling.md
- Python Tutorials:
- Overview: python/index.md
- Install Python Interpreter: python/install.md
- Examples:
- Overview: python/examples/index.md
- Blinky: python/examples/blinky.md
- Button: python/examples/button.md
- microSD Card: python/examples/microsd.md
- TFT LCD Display: python/examples/lcd.md
- USB HID Keyboard: python/examples/usb-keyboard.md
- BLE HID Keyboard: python/examples/ble-keyboard.md
- nRF5 SDK Tutorials:
- Overview: nrf5-sdk/index.md
- Setup the nRF5 SDK: nrf5-sdk/setup.md
- Build & Run a first example: nrf5-sdk/building.md
- Examples:
- Peripheral:
- Blinky: nrf5-sdk/examples/blinky.md
- BSP: nrf5-sdk/examples/bsp.md
- Battery Status: nrf5-sdk/examples/battery.md
- microSD Card: nrf5-sdk/examples/microsd.md
- NFC Tag: nrf5-sdk/examples/nfc.md
- Power Profiling: nrf5-sdk/examples/power-profiling.md
- QSPI Flash: nrf5-sdk/examples/qspi.md
- RSSI Viewer: nrf5-sdk/examples/rssi-viewer.md
- Temperature: nrf5-sdk/examples/temperature.md
- TFT LCD Display: nrf5-sdk/examples/tft-lcd.md
- USB CDC ACM: nrf5-sdk/examples/usb-cdc-acm.md
- Bluetooth Low Energy:
- BLE Blinky: nrf5-sdk/examples/ble-blinky.md
- BLE Beacon: nrf5-sdk/examples/ble-beacon.md
- BLE Battery Service: nrf5-sdk/examples/ble-bas.md
- BLE CLI: nrf5-sdk/examples/ble-cli.md
- BLE Heart Rate Service: nrf5-sdk/examples/ble-hrs.md
- BLE HID Keyboard: nrf5-sdk/examples/ble-hids-keyboard.md
- BLE HID Mouse: nrf5-sdk/examples/ble-hids-mouse.md
- Zephyr OS Tutorials:
- Overview: zephyr/index.md
- Setup the toolchain: zephyr/setup.md
- Build & Run a first example: zephyr/building.md
- Examples:
- Overview: zephyr/examples/index.md
- Hello World: zephyr/examples/hello-world.md
- Blinky: zephyr/examples/blinky.md
- Button: zephyr/examples/button.md
- SPI Flash: zephyr/examples/spi-flash.md
- FAT Filesystem: zephyr/examples/fat-fs.md
- LittlevGL: zephyr/examples/littlevgl.md
- File System Shell: zephyr/examples/shell-fs.md
- BLE Beacon: zephyr/examples/ble-beacon.md
- BLE Peripheral DIS: zephyr/examples/ble-dis.md
- BLE Peripheral HIDs: zephyr/examples/ble-hids.md
- Resources: resources.md
- Where to Buy: where-to-buy.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
# Google Analytics
google_analytics:
- 'UA-54344624-2'
- auto