Skip to content

Commit 7669be4

Browse files
xiongyihuixiongyihui
committed
add mkdocs config
1 parent fdc17db commit 7669be4

File tree

2 files changed

+146
-1
lines changed

2 files changed

+146
-1
lines changed

‎docs/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
M60 is a hot-swappable 60% Keyboard with USB, BLE 5.0 and RGB backlight. It is highly configurable and extensible.
44
It can run Python code saved in its USB storage, which makes it super powerful. It has very low power consumption and only needs about 160uA current when connected to a computer via Bluetooth. It is one of the lowest latency USB keyboards.
55

6+
![](https://github.com/makerdiary/python-keyboard/raw/master/img/m60.jpg)
7+
68
## Features
79

810
- BLE 5.0 Multi-pairing up to 10 devices
@@ -16,7 +18,7 @@ It can run Python code saved in its USB storage, which makes it super powerful.
1618
- All keys remappable
1719
- Up to 32 layers
1820
- Macros
19-
- Customized functions
21+
- Pair-keys
2022

2123
## Specs
2224

‎mkdocs.yml

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# Copyright (c) 2020 makerdiary.com
2+
3+
# Permission is hereby granted, free of charge, to any person obtaining a copy
4+
# of this software and associated documentation files (the "Software"), to deal
5+
# in the Software without restriction, including without limitation the rights
6+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
# copies of the Software, and to permit persons to whom the Software is
8+
# furnished to do so, subject to the following conditions:
9+
10+
# The above copyright notice and this permission notice shall be included in all
11+
# copies or substantial portions of the Software.
12+
13+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
# SOFTWARE.
20+
21+
# Project information
22+
site_name: M60 Keyboard
23+
site_description: The documentation offers all you need to start using M60 Keyboard.
24+
site_author: makerdiary
25+
site_url: https://wiki.makerdiary.com/python-keyboard
26+
27+
# Repository
28+
repo_name: makerdiary/python-keyboard
29+
repo_url: https://github.com/makerdiary/python-keyboard
30+
edit_uri: ""
31+
32+
# Copyright
33+
copyright: 'Copyright &copy; 2020 <a href="https://wiki.makerdiary.com" target="_blank">wiki.makerdiary.com</a>'
34+
35+
# Configuration
36+
theme:
37+
name: null
38+
custom_dir: 'mkdocs-material/material'
39+
40+
# 404 page
41+
static_templates:
42+
- 404.html
43+
44+
# Don't include MkDocs' JavaScript
45+
include_search_page: false
46+
search_index_only: true
47+
48+
# Default values, taken from mkdocs_theme.yml
49+
language: en
50+
features:
51+
- tabs
52+
#- instant
53+
palette:
54+
scheme: default
55+
primary: red-bud
56+
accent: red-bud
57+
font:
58+
text: Roboto
59+
code: Roboto Mono
60+
icon:
61+
logo: logo
62+
favicon: assets/images/favicon.png
63+
64+
# Plugins
65+
plugins:
66+
- search
67+
- minify:
68+
minify_html: true
69+
70+
# Customization
71+
extra:
72+
social:
73+
- icon: fontawesome/brands/shopify
74+
link: https://store.makerdiary.com
75+
- icon: fontawesome/brands/github
76+
link: https://github.com/makerdiary
77+
- icon: fontawesome/brands/twitter
78+
link: https://twitter.com/makerdiary
79+
- icon: fontawesome/brands/discourse
80+
link: https://community.makerdiary.com
81+
- icon: fontawesome/brands/youtube
82+
link: https://www.youtube.com/channel/UCX4nJNlsyj9VJeQOHgOs0yg
83+
- icon: fontawesome/brands/medium
84+
link: https://medium.com/makerdiary
85+
- icon: fontawesome/brands/zhihu
86+
link: https://zhuanlan.zhihu.com/makerdiary
87+
88+
89+
# disqus: 'makerdiary'
90+
# discourse: 'community.makerdiary.com’
91+
92+
# Extensions
93+
markdown_extensions:
94+
- markdown.extensions.admonition
95+
- markdown.extensions.attr_list
96+
- markdown.extensions.codehilite:
97+
guess_lang: false
98+
- markdown.extensions.def_list
99+
- markdown.extensions.footnotes
100+
- markdown.extensions.meta
101+
- markdown.extensions.toc:
102+
permalink: true
103+
- pymdownx.arithmatex
104+
- pymdownx.betterem:
105+
smart_enable: all
106+
- pymdownx.caret
107+
- pymdownx.critic
108+
- pymdownx.details
109+
- pymdownx.emoji:
110+
emoji_index: !!python/name:materialx.emoji.twemoji
111+
emoji_generator: !!python/name:materialx.emoji.to_svg
112+
#- pymdownx.highlight:
113+
# linenums_style: pymdownx-inline
114+
- pymdownx.inlinehilite
115+
- pymdownx.keys
116+
- pymdownx.magiclink:
117+
repo_url_shorthand: true
118+
user: makerdiary
119+
repo: mx-keyboard
120+
- pymdownx.mark
121+
- pymdownx.smartsymbols
122+
- pymdownx.snippets:
123+
check_paths: true
124+
- pymdownx.superfences
125+
- pymdownx.tabbed
126+
- pymdownx.tasklist:
127+
custom_checkbox: true
128+
- pymdownx.tilde
129+
130+
# Page tree
131+
nav:
132+
- Introduction: index.md
133+
- Getting started: getting-started.md
134+
- Configuration: configuration.md
135+
- Macro: macro.md
136+
- Pair-Keys: pair-keys.md
137+
- Upgrade: upgrade_firmware.md
138+
- Contributing: CONTRIBUTING.md
139+
140+
# Google Analytics
141+
google_analytics:
142+
- 'UA-54344624-2'
143+
- auto

0 commit comments

Comments
 (0)