Use docsfy to replace gitbook
skullY
skullydazed
parent
06e5f9b25e
commit
9e5676650e
|
|
@ -1,18 +1,25 @@
|
||||||
# Quantum Mechanical Keyboard Firmware
|
# Quantum Mechanical Keyboard Firmware
|
||||||
|
|
||||||
## What is QMK Firmware? {#what-is-qmk-firmware}
|
[](https://github.com/qmk/qmk_firmware/tags)
|
||||||
|
[](https://travis-ci.org/qmk/qmk_firmware)
|
||||||
|
[](https://discord.gg/Uq7gcHh)
|
||||||
|
[](https://docs.qmk.fm)
|
||||||
|
[](https://github.com/qmk/qmk_firmware/pulse/monthly)
|
||||||
|
[](https://github.com/qmk/qmk_firmware/)
|
||||||
|
|
||||||
|
## What is QMK Firmware?
|
||||||
|
|
||||||
QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
|
QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
|
||||||
|
|
||||||
## How to Get It {#how-to-get-it}
|
## How to Get It
|
||||||
|
|
||||||
If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](https://github.com/qmk/qmk_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](https://github.com/qmk/qmk_firmware/pulls) from your fork.
|
If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](https://github.com/qmk/qmk_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](https://github.com/qmk/qmk_firmware/pulls) from your fork.
|
||||||
|
|
||||||
Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), or clone it via git (`git@github.com:qmk/qmk_firmware.git`), or https (`https://github.com/qmk/qmk_firmware.git`).
|
Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), or clone it via git (`git@github.com:qmk/qmk_firmware.git`), or https (`https://github.com/qmk/qmk_firmware.git`).
|
||||||
|
|
||||||
## How to Compile {#how-to-compile}
|
## How to Compile
|
||||||
|
|
||||||
Before you are able to compile, you'll need to [install an environment](getting_started_build_tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation:
|
Before you are able to compile, you'll need to [install an environment](01_Getting_Started/01_Install_Build_Tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation:
|
||||||
|
|
||||||
make planck/rev4:default
|
make planck/rev4:default
|
||||||
|
|
||||||
|
|
@ -20,6 +27,6 @@ This would build the `rev4` revision of the `planck` with the `default` keymap.
|
||||||
|
|
||||||
make preonic:default
|
make preonic:default
|
||||||
|
|
||||||
## How to Customize {#how-to-customize}
|
## How to Customize
|
||||||
|
|
||||||
QMK has lots of [features](features.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).
|
QMK has lots of [features](05_Features/index.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](07_Reference/Keymap_Overview.md), and changing the [keycodes](06_Keycodes/index.md).
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,98 @@
|
||||||
|
* [Getting Started](README.md)
|
||||||
|
* [QMK Introduction](getting_started_introduction.md)
|
||||||
|
* [Install Build Tools](getting_started_build_tools.md)
|
||||||
|
* Alternative: [Vagrant Guide](getting_started_vagrant.md)
|
||||||
|
* [Build/Compile Instructions](getting_started_make_guide.md)
|
||||||
|
* [Flashing Firmware](flashing.md)
|
||||||
|
* [Contributing to QMK](contributing.md)
|
||||||
|
* [How to Use Github](getting_started_github.md)
|
||||||
|
* [Getting Help](getting_started_getting_help.md)
|
||||||
|
|
||||||
|
* [Complete Newbs Guide](newbs.md)
|
||||||
|
* [Getting Started](newbs_getting_started.md)
|
||||||
|
* [Building Your First Firmware](newbs_building_firmware.md)
|
||||||
|
* [Flashing Firmware](newbs_flashing.md)
|
||||||
|
* [Testing and Debugging](newbs_testing_debugging.md)
|
||||||
|
|
||||||
|
* [FAQ](faq.md)
|
||||||
|
* [General FAQ](faq_general.md)
|
||||||
|
* [Build/Compile QMK](faq_build.md)
|
||||||
|
* [Debugging/Troubleshooting QMK](faq_debug.md)
|
||||||
|
* [Keymap](faq_keymap.md)
|
||||||
|
|
||||||
|
* [Hardware](hardware.md)
|
||||||
|
* [Keyboard Guidelines](hardware_keyboard_guidelines.md)
|
||||||
|
* [AVR Processors](hardware_avr.md)
|
||||||
|
* ARM Processors (TBD)
|
||||||
|
* [Drivers](hardware_drivers.md)
|
||||||
|
|
||||||
|
* [Features](features.md)
|
||||||
|
* [Advanced Keycodes](feature_advanced_keycodes.md)
|
||||||
|
* [Audio](feature_audio.md)
|
||||||
|
* [Auto Shift](feature_auto_shift.md)
|
||||||
|
* [Backlight](feature_backlight.md)
|
||||||
|
* [Bootmagic](feature_bootmagic.md)
|
||||||
|
* [Command](feature_command.md)
|
||||||
|
* [Dynamic Macros](feature_dynamic_macros.md)
|
||||||
|
* [Grave Escape](feature_grave_esc.md)
|
||||||
|
* [Key Lock](feature_key_lock.md)
|
||||||
|
* [Layouts](feature_layouts.md)
|
||||||
|
* [Leader Key](feature_leader_key.md)
|
||||||
|
* [Macros](feature_macros.md)
|
||||||
|
* [Mouse Keys](feature_mouse_keys.md)
|
||||||
|
* [Pointing Device](feature_pointing_device.md)
|
||||||
|
* [PS/2 Mouse](feature_ps2_mouse.md)
|
||||||
|
* [RGB Lighting](feature_rgblight.md)
|
||||||
|
* [Space Cadet](feature_space_cadet.md)
|
||||||
|
* [Stenography](feature_stenography.md)
|
||||||
|
* [Swap Hands](feature_swap_hands.md)
|
||||||
|
* [Tap Dance](feature_tap_dance.md)
|
||||||
|
* [Terminal](feature_terminal.md)
|
||||||
|
* [Thermal Printer](feature_thermal_printer.md)
|
||||||
|
* [Unicode](feature_unicode.md)
|
||||||
|
* [Userspace](feature_userspace.md)
|
||||||
|
|
||||||
|
* [Keycodes](keycodes.md)
|
||||||
|
* [Backlight](feature_backlight.md#backlight-keycodes)
|
||||||
|
* [Basic](keycodes_basic.md)
|
||||||
|
* [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
|
||||||
|
* [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
|
||||||
|
* [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
|
||||||
|
* [Mod+Key](feature_advanced_keycodes.md#modifier-keys)
|
||||||
|
* [Mod Tap](feature_advanced_keycodes.md#mod-tap)
|
||||||
|
* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
|
||||||
|
* [Quantum](quantum_keycodes.md)
|
||||||
|
* [RGB Light](feature_rgblight.md#rgblight-keycodes)
|
||||||
|
* [Shifted Keys](feature_advanced_keycodes.md#shifted-keycodes)
|
||||||
|
* [Stenography](feature_stenography.md#keycode-reference)
|
||||||
|
* [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
|
||||||
|
* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
|
||||||
|
|
||||||
|
* Reference
|
||||||
|
* [Config Options](config_options.md)
|
||||||
|
* [Customizing Functionality](custom_quantum_functions.md)
|
||||||
|
* [Documentation Best Practices](documentation_best_practices.md)
|
||||||
|
* [Documentation Templates](documentation_templates.md)
|
||||||
|
* [Glossary](reference_glossary.md)
|
||||||
|
* [Keymap Overview](keymap.md)
|
||||||
|
* [Unit Testing](unit_testing.md)
|
||||||
|
|
||||||
|
* For Makers and Modders
|
||||||
|
* [Hand Wiring Guide](hand_wire.md)
|
||||||
|
* [ISP Flashing Guide](isp_flashing_guide.md)
|
||||||
|
|
||||||
|
* For a Deeper Understanding
|
||||||
|
* [How Keyboards Work](how_keyboards_work.md)
|
||||||
|
* [Understanding QMK](understanding_qmk.md)
|
||||||
|
|
||||||
|
* Other Topics
|
||||||
|
* [Using Eclipse with QMK](eclipse.md)
|
||||||
|
|
||||||
|
* QMK Internals (In Progress)
|
||||||
|
* [Defines](internals_defines.md)
|
||||||
|
* [Input Callback Reg](internals_input_callback_reg.md)
|
||||||
|
* [Midi Device](internals_midi_device.md)
|
||||||
|
* [Midi Device Setup Process](internals_midi_device_setup_process.md)
|
||||||
|
* [Midi Util](internals_midi_util.md)
|
||||||
|
* [Send Functions](internals_send_functions.md)
|
||||||
|
* [Sysex Tools](internals_sysex_tools.md)
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>Document</title>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||||||
|
<meta name="description" content="Description">
|
||||||
|
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
||||||
|
<link rel="stylesheet" href="qmk.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="app"></div>
|
||||||
|
<script>
|
||||||
|
window.$docsify = {
|
||||||
|
name: 'QMK Firmware',
|
||||||
|
nameLink: 'https://qmk.fm/',
|
||||||
|
repo: 'qmk/qmk_firmware',
|
||||||
|
loadSidebar: true,
|
||||||
|
subMaxLevel: 2,
|
||||||
|
auto2top: true,
|
||||||
|
formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}',
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
||||||
|
<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
|
||||||
|
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
|
||||||
|
<script src="//unpkg.com/prismjs/components/prism-c.min.js"></script>
|
||||||
|
<script src="//unpkg.com/prismjs/components/prism-cpp.min.js"></script>
|
||||||
|
<script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
|
||||||
|
<script src="//unpkg.com/prismjs/components/prism-makefile.min.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,862 @@
|
||||||
|
* {
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
-webkit-overflow-scrolling: touch;
|
||||||
|
-webkit-tap-highlight-color: rgba(0,0,0,0);
|
||||||
|
-webkit-text-size-adjust: none;
|
||||||
|
-webkit-touch-callout: none;
|
||||||
|
-webkit-box-sizing: border-box;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
body:not(.ready) {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
body:not(.ready) [data-cloak],
|
||||||
|
body:not(.ready) .app-nav,
|
||||||
|
body:not(.ready) > nav {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
div#app {
|
||||||
|
font-size: 30px;
|
||||||
|
font-weight: lighter;
|
||||||
|
margin: 40vh auto;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
div#app:empty::before {
|
||||||
|
content: 'Loading...';
|
||||||
|
}
|
||||||
|
.emoji {
|
||||||
|
height: 1.2rem;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
.progress {
|
||||||
|
background-color: var(--theme-color, #ea6f5a);
|
||||||
|
height: 2px;
|
||||||
|
left: 0px;
|
||||||
|
position: fixed;
|
||||||
|
right: 0px;
|
||||||
|
top: 0px;
|
||||||
|
-webkit-transition: width 0.2s, opacity 0.4s;
|
||||||
|
transition: width 0.2s, opacity 0.4s;
|
||||||
|
width: 0%;
|
||||||
|
z-index: 999999;
|
||||||
|
}
|
||||||
|
.search a:hover {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
}
|
||||||
|
.search .search-keyword {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
html,
|
||||||
|
body {
|
||||||
|
height: 100%;
|
||||||
|
}
|
||||||
|
body {
|
||||||
|
-moz-osx-font-smoothing: grayscale;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
color: #efefef;
|
||||||
|
font-family: 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
|
||||||
|
font-size: 15px;
|
||||||
|
letter-spacing: 0;
|
||||||
|
margin: 0;
|
||||||
|
overflow-x: hidden;
|
||||||
|
}
|
||||||
|
img {
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
a[disabled] {
|
||||||
|
cursor: not-allowed;
|
||||||
|
opacity: 0.6;
|
||||||
|
}
|
||||||
|
kbd {
|
||||||
|
border: solid 1px #ccc;
|
||||||
|
border-radius: 3px;
|
||||||
|
display: inline-block;
|
||||||
|
font-size: 12px !important;
|
||||||
|
line-height: 12px;
|
||||||
|
margin-bottom: 3px;
|
||||||
|
padding: 3px 5px;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
.task-list-item {
|
||||||
|
list-style-type: none;
|
||||||
|
}
|
||||||
|
li input[type='checkbox'] {
|
||||||
|
margin: 0 0.2em 0.25em -1.6em;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
.app-nav {
|
||||||
|
margin: 25px 60px 0 0;
|
||||||
|
position: absolute;
|
||||||
|
right: 0;
|
||||||
|
text-align: right;
|
||||||
|
z-index: 10;
|
||||||
|
/* navbar dropdown */
|
||||||
|
}
|
||||||
|
.app-nav.no-badge {
|
||||||
|
margin-right: 25px;
|
||||||
|
}
|
||||||
|
.app-nav p {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
.app-nav > a {
|
||||||
|
margin: 0 1rem;
|
||||||
|
padding: 5px 0;
|
||||||
|
}
|
||||||
|
.app-nav ul,
|
||||||
|
.app-nav li {
|
||||||
|
display: inline-block;
|
||||||
|
list-style: none;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
.app-nav a {
|
||||||
|
color: inherit;
|
||||||
|
font-size: 16px;
|
||||||
|
text-decoration: none;
|
||||||
|
-webkit-transition: color 0.3s;
|
||||||
|
transition: color 0.3s;
|
||||||
|
}
|
||||||
|
.app-nav a:hover {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
}
|
||||||
|
.app-nav a.active {
|
||||||
|
border-bottom: 2px solid var(--theme-color, #ea6f5a);
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
}
|
||||||
|
.app-nav li {
|
||||||
|
display: inline-block;
|
||||||
|
margin: 0 1rem;
|
||||||
|
padding: 5px 0;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
.app-nav li ul {
|
||||||
|
background-color: #fff;
|
||||||
|
border: 1px solid #ddd;
|
||||||
|
border-bottom-color: #ccc;
|
||||||
|
border-radius: 4px;
|
||||||
|
-webkit-box-sizing: border-box;
|
||||||
|
box-sizing: border-box;
|
||||||
|
display: none;
|
||||||
|
max-height: calc(100vh - 61px);
|
||||||
|
overflow-y: auto;
|
||||||
|
padding: 10px 0;
|
||||||
|
position: absolute;
|
||||||
|
right: -15px;
|
||||||
|
text-align: left;
|
||||||
|
top: 100%;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
.app-nav li ul li {
|
||||||
|
display: block;
|
||||||
|
font-size: 14px;
|
||||||
|
line-height: 1rem;
|
||||||
|
margin: 0;
|
||||||
|
margin: 8px 14px;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
.app-nav li ul a {
|
||||||
|
display: block;
|
||||||
|
font-size: inherit;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
.app-nav li ul a.active {
|
||||||
|
border-bottom: 0;
|
||||||
|
}
|
||||||
|
.app-nav li:hover ul {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
.github-corner {
|
||||||
|
border-bottom: 0;
|
||||||
|
position: fixed;
|
||||||
|
right: 0;
|
||||||
|
text-decoration: none;
|
||||||
|
top: 0;
|
||||||
|
z-index: 1;
|
||||||
|
}
|
||||||
|
.github-corner:hover .octo-arm {
|
||||||
|
-webkit-animation: octocat-wave 560ms ease-in-out;
|
||||||
|
animation: octocat-wave 560ms ease-in-out;
|
||||||
|
}
|
||||||
|
.github-corner svg {
|
||||||
|
color: #3f3f3f;
|
||||||
|
fill: var(--theme-color, #ea6f5a);
|
||||||
|
height: 80px;
|
||||||
|
width: 80px;
|
||||||
|
}
|
||||||
|
main {
|
||||||
|
display: block;
|
||||||
|
position: relative;
|
||||||
|
width: 100vw;
|
||||||
|
height: 100%;
|
||||||
|
z-index: 0;
|
||||||
|
}
|
||||||
|
main.hidden {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.anchor {
|
||||||
|
display: inline-block;
|
||||||
|
text-decoration: none;
|
||||||
|
-webkit-transition: all 0.3s;
|
||||||
|
transition: all 0.3s;
|
||||||
|
}
|
||||||
|
.anchor span {
|
||||||
|
color: #c8c8c8;
|
||||||
|
}
|
||||||
|
.anchor:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
.sidebar {
|
||||||
|
border-right: 1px solid rgba(0,0,0,0.07);
|
||||||
|
overflow-y: auto;
|
||||||
|
padding: 40px 0 0;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
left: 0;
|
||||||
|
-webkit-transition: -webkit-transform 250ms ease-out;
|
||||||
|
transition: -webkit-transform 250ms ease-out;
|
||||||
|
transition: transform 250ms ease-out;
|
||||||
|
transition: transform 250ms ease-out, -webkit-transform 250ms ease-out;
|
||||||
|
width: 300px;
|
||||||
|
z-index: 20;
|
||||||
|
}
|
||||||
|
.sidebar > h1 {
|
||||||
|
margin: 0 auto 1rem;
|
||||||
|
font-size: 1.5rem;
|
||||||
|
font-weight: 300;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.sidebar > h1 a {
|
||||||
|
color: inherit;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
.sidebar > h1 .app-nav {
|
||||||
|
display: block;
|
||||||
|
position: static;
|
||||||
|
}
|
||||||
|
.sidebar .sidebar-nav {
|
||||||
|
line-height: 2em;
|
||||||
|
padding-bottom: 40px;
|
||||||
|
}
|
||||||
|
.sidebar li.collapse .app-sub-sidebar {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.sidebar ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
.sidebar li > p {
|
||||||
|
font-weight: 700;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
.sidebar ul,
|
||||||
|
.sidebar ul li {
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
.sidebar ul li a {
|
||||||
|
border-bottom: none;
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
.sidebar ul li ul {
|
||||||
|
padding-left: 20px;
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar {
|
||||||
|
width: 4px;
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar-thumb {
|
||||||
|
background: transparent;
|
||||||
|
border-radius: 4px;
|
||||||
|
}
|
||||||
|
.sidebar:hover::-webkit-scrollbar-thumb {
|
||||||
|
background: rgba(136,136,136,0.4);
|
||||||
|
}
|
||||||
|
.sidebar:hover::-webkit-scrollbar-track {
|
||||||
|
background: rgba(136,136,136,0.1);
|
||||||
|
}
|
||||||
|
.sidebar-toggle {
|
||||||
|
background-color: transparent;
|
||||||
|
background-color: rgba(63,63,63,0.8);
|
||||||
|
border: 0;
|
||||||
|
outline: none;
|
||||||
|
padding: 10px;
|
||||||
|
position: absolute;
|
||||||
|
bottom: 0;
|
||||||
|
left: 0;
|
||||||
|
text-align: center;
|
||||||
|
-webkit-transition: opacity 0.3s;
|
||||||
|
transition: opacity 0.3s;
|
||||||
|
width: 284px;
|
||||||
|
z-index: 30;
|
||||||
|
}
|
||||||
|
.sidebar-toggle .sidebar-toggle-button:hover {
|
||||||
|
opacity: 0.4;
|
||||||
|
}
|
||||||
|
.sidebar-toggle span {
|
||||||
|
background-color: var(--theme-color, #ea6f5a);
|
||||||
|
display: block;
|
||||||
|
margin-bottom: 4px;
|
||||||
|
width: 16px;
|
||||||
|
height: 2px;
|
||||||
|
}
|
||||||
|
body.sticky .sidebar,
|
||||||
|
body.sticky .sidebar-toggle {
|
||||||
|
position: fixed;
|
||||||
|
}
|
||||||
|
.content {
|
||||||
|
padding-top: 60px;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
right: 0;
|
||||||
|
bottom: 0;
|
||||||
|
left: 300px;
|
||||||
|
-webkit-transition: left 250ms ease;
|
||||||
|
transition: left 250ms ease;
|
||||||
|
}
|
||||||
|
.markdown-section {
|
||||||
|
margin: 0 auto;
|
||||||
|
max-width: 800px;
|
||||||
|
padding: 30px 15px 40px 15px;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
.markdown-section > * {
|
||||||
|
-webkit-box-sizing: border-box;
|
||||||
|
box-sizing: border-box;
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
.markdown-section > :first-child {
|
||||||
|
margin-top: 0 !important;
|
||||||
|
}
|
||||||
|
.markdown-section hr {
|
||||||
|
border: none;
|
||||||
|
border-bottom: 1px solid #eee;
|
||||||
|
margin: 2em 0;
|
||||||
|
}
|
||||||
|
.markdown-section iframe {
|
||||||
|
border: 1px solid #eee;
|
||||||
|
}
|
||||||
|
.markdown-section table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
border-spacing: 0;
|
||||||
|
display: block;
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
overflow: auto;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
.markdown-section th {
|
||||||
|
border: 1px solid #ddd;
|
||||||
|
font-weight: bold;
|
||||||
|
padding: 6px 13px;
|
||||||
|
}
|
||||||
|
.markdown-section td {
|
||||||
|
border: 1px solid #ddd;
|
||||||
|
padding: 6px 13px;
|
||||||
|
}
|
||||||
|
.markdown-section tr {
|
||||||
|
border-top: 1px solid #ccc;
|
||||||
|
}
|
||||||
|
.markdown-section tr:nth-child(2n) {
|
||||||
|
background-color: #f8f8f8;
|
||||||
|
}
|
||||||
|
.markdown-section p.tip {
|
||||||
|
background-color: #f8f8f8;
|
||||||
|
border-bottom-right-radius: 2px;
|
||||||
|
border-left: 4px solid #f66;
|
||||||
|
border-top-right-radius: 2px;
|
||||||
|
margin: 2em 0;
|
||||||
|
padding: 12px 24px 12px 30px;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
.markdown-section p.tip:before {
|
||||||
|
background-color: #f66;
|
||||||
|
border-radius: 100%;
|
||||||
|
color: #3f3f3f;
|
||||||
|
content: '!';
|
||||||
|
font-family: 'Dosis', 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
|
||||||
|
font-size: 14px;
|
||||||
|
font-weight: bold;
|
||||||
|
left: -12px;
|
||||||
|
line-height: 20px;
|
||||||
|
position: absolute;
|
||||||
|
height: 20px;
|
||||||
|
width: 20px;
|
||||||
|
text-align: center;
|
||||||
|
top: 14px;
|
||||||
|
}
|
||||||
|
.markdown-section p.tip code {
|
||||||
|
background-color: #efefef;
|
||||||
|
}
|
||||||
|
.markdown-section p.tip em {
|
||||||
|
color: #c8c8c8;
|
||||||
|
}
|
||||||
|
.markdown-section p.warn {
|
||||||
|
background: rgba(234,111,90,0.1);
|
||||||
|
border-radius: 2px;
|
||||||
|
padding: 1rem;
|
||||||
|
}
|
||||||
|
body.close .sidebar {
|
||||||
|
-webkit-transform: translateX(-300px);
|
||||||
|
transform: translateX(-300px);
|
||||||
|
}
|
||||||
|
body.close .sidebar-toggle {
|
||||||
|
width: auto;
|
||||||
|
}
|
||||||
|
body.close .content {
|
||||||
|
left: 0;
|
||||||
|
}
|
||||||
|
@media print {
|
||||||
|
.github-corner,
|
||||||
|
.sidebar-toggle,
|
||||||
|
.sidebar,
|
||||||
|
.app-nav {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media screen and (max-width: 768px) {
|
||||||
|
.github-corner,
|
||||||
|
.sidebar-toggle,
|
||||||
|
.sidebar {
|
||||||
|
position: fixed;
|
||||||
|
}
|
||||||
|
.app-nav {
|
||||||
|
margin-top: 16px;
|
||||||
|
}
|
||||||
|
.app-nav li ul {
|
||||||
|
top: 30px;
|
||||||
|
}
|
||||||
|
main {
|
||||||
|
height: auto;
|
||||||
|
overflow-x: hidden;
|
||||||
|
}
|
||||||
|
.sidebar {
|
||||||
|
left: -300px;
|
||||||
|
-webkit-transition: -webkit-transform 250ms ease-out;
|
||||||
|
transition: -webkit-transform 250ms ease-out;
|
||||||
|
transition: transform 250ms ease-out;
|
||||||
|
transition: transform 250ms ease-out, -webkit-transform 250ms ease-out;
|
||||||
|
}
|
||||||
|
.content {
|
||||||
|
left: 0;
|
||||||
|
max-width: 100vw;
|
||||||
|
position: static;
|
||||||
|
padding-top: 20px;
|
||||||
|
-webkit-transition: -webkit-transform 250ms ease;
|
||||||
|
transition: -webkit-transform 250ms ease;
|
||||||
|
transition: transform 250ms ease;
|
||||||
|
transition: transform 250ms ease, -webkit-transform 250ms ease;
|
||||||
|
}
|
||||||
|
.app-nav,
|
||||||
|
.github-corner {
|
||||||
|
-webkit-transition: -webkit-transform 250ms ease-out;
|
||||||
|
transition: -webkit-transform 250ms ease-out;
|
||||||
|
transition: transform 250ms ease-out;
|
||||||
|
transition: transform 250ms ease-out, -webkit-transform 250ms ease-out;
|
||||||
|
}
|
||||||
|
.sidebar-toggle {
|
||||||
|
background-color: transparent;
|
||||||
|
width: auto;
|
||||||
|
padding: 30px 30px 10px 10px;
|
||||||
|
}
|
||||||
|
body.close .sidebar {
|
||||||
|
-webkit-transform: translateX(300px);
|
||||||
|
transform: translateX(300px);
|
||||||
|
}
|
||||||
|
body.close .sidebar-toggle {
|
||||||
|
background-color: rgba(63,63,63,0.8);
|
||||||
|
-webkit-transition: 1s background-color;
|
||||||
|
transition: 1s background-color;
|
||||||
|
width: 284px;
|
||||||
|
padding: 10px;
|
||||||
|
}
|
||||||
|
body.close .content {
|
||||||
|
-webkit-transform: translateX(300px);
|
||||||
|
transform: translateX(300px);
|
||||||
|
}
|
||||||
|
body.close .app-nav,
|
||||||
|
body.close .github-corner {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.github-corner:hover .octo-arm {
|
||||||
|
-webkit-animation: none;
|
||||||
|
animation: none;
|
||||||
|
}
|
||||||
|
.github-corner .octo-arm {
|
||||||
|
-webkit-animation: octocat-wave 560ms ease-in-out;
|
||||||
|
animation: octocat-wave 560ms ease-in-out;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@-webkit-keyframes octocat-wave {
|
||||||
|
0%, 100% {
|
||||||
|
-webkit-transform: rotate(0);
|
||||||
|
transform: rotate(0);
|
||||||
|
}
|
||||||
|
20%, 60% {
|
||||||
|
-webkit-transform: rotate(-25deg);
|
||||||
|
transform: rotate(-25deg);
|
||||||
|
}
|
||||||
|
40%, 80% {
|
||||||
|
-webkit-transform: rotate(10deg);
|
||||||
|
transform: rotate(10deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@keyframes octocat-wave {
|
||||||
|
0%, 100% {
|
||||||
|
-webkit-transform: rotate(0);
|
||||||
|
transform: rotate(0);
|
||||||
|
}
|
||||||
|
20%, 60% {
|
||||||
|
-webkit-transform: rotate(-25deg);
|
||||||
|
transform: rotate(-25deg);
|
||||||
|
}
|
||||||
|
40%, 80% {
|
||||||
|
-webkit-transform: rotate(10deg);
|
||||||
|
transform: rotate(10deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
section.cover {
|
||||||
|
-webkit-box-align: center;
|
||||||
|
-ms-flex-align: center;
|
||||||
|
align-items: center;
|
||||||
|
background-position: center center;
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
background-size: cover;
|
||||||
|
height: 100vh;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
section.cover.show {
|
||||||
|
display: -webkit-box;
|
||||||
|
display: -ms-flexbox;
|
||||||
|
display: flex;
|
||||||
|
}
|
||||||
|
section.cover.has-mask .mask {
|
||||||
|
background-color: #3f3f3f;
|
||||||
|
opacity: 0.8;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
height: 100%;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
section.cover .cover-main {
|
||||||
|
-webkit-box-flex: 1;
|
||||||
|
-ms-flex: 1;
|
||||||
|
flex: 1;
|
||||||
|
margin: -20px 16px 0;
|
||||||
|
text-align: center;
|
||||||
|
z-index: 1;
|
||||||
|
}
|
||||||
|
section.cover a {
|
||||||
|
color: inherit;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
section.cover a:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
section.cover p {
|
||||||
|
line-height: 1.5rem;
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
section.cover h1 {
|
||||||
|
color: inherit;
|
||||||
|
font-size: 2.5rem;
|
||||||
|
font-weight: 300;
|
||||||
|
margin: 0.625rem 0 2.5rem;
|
||||||
|
position: relative;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
section.cover h1 a {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
section.cover h1 small {
|
||||||
|
bottom: -0.4375rem;
|
||||||
|
font-size: 1rem;
|
||||||
|
position: absolute;
|
||||||
|
}
|
||||||
|
section.cover blockquote {
|
||||||
|
font-size: 1.5rem;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
section.cover ul {
|
||||||
|
line-height: 1.8;
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 1em auto;
|
||||||
|
max-width: 500px;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
section.cover .cover-main > p:last-child a {
|
||||||
|
border-color: var(--theme-color, #ea6f5a);
|
||||||
|
border-radius: 2rem;
|
||||||
|
border-style: solid;
|
||||||
|
border-width: 1px;
|
||||||
|
-webkit-box-sizing: border-box;
|
||||||
|
box-sizing: border-box;
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
display: inline-block;
|
||||||
|
font-size: 1.05rem;
|
||||||
|
letter-spacing: 0.1rem;
|
||||||
|
margin: 0.5rem 1rem;
|
||||||
|
padding: 0.75em 2rem;
|
||||||
|
text-decoration: none;
|
||||||
|
-webkit-transition: all 0.15s ease;
|
||||||
|
transition: all 0.15s ease;
|
||||||
|
}
|
||||||
|
section.cover .cover-main > p:last-child a:last-child {
|
||||||
|
background-color: var(--theme-color, #ea6f5a);
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
section.cover .cover-main > p:last-child a:last-child:hover {
|
||||||
|
color: inherit;
|
||||||
|
opacity: 0.8;
|
||||||
|
}
|
||||||
|
section.cover .cover-main > p:last-child a:hover {
|
||||||
|
color: inherit;
|
||||||
|
}
|
||||||
|
section.cover blockquote > p > a {
|
||||||
|
border-bottom: 2px solid var(--theme-color, #ea6f5a);
|
||||||
|
-webkit-transition: color 0.3s;
|
||||||
|
transition: color 0.3s;
|
||||||
|
}
|
||||||
|
section.cover blockquote > p > a:hover {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
}
|
||||||
|
body {
|
||||||
|
background-color: #3f3f3f;
|
||||||
|
}
|
||||||
|
/* sidebar */
|
||||||
|
.sidebar {
|
||||||
|
background-color: #3f3f3f;
|
||||||
|
color: #c8c8c8;
|
||||||
|
}
|
||||||
|
.sidebar li {
|
||||||
|
margin: 6px 15px;
|
||||||
|
}
|
||||||
|
.sidebar ul li a {
|
||||||
|
color: #c8c8c8;
|
||||||
|
font-size: 14px;
|
||||||
|
overflow: hidden;
|
||||||
|
text-decoration: none;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
.sidebar ul li a:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
.sidebar ul li ul {
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
.sidebar ul li.active > a {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
/* markdown content found on pages */
|
||||||
|
.markdown-section h1,
|
||||||
|
.markdown-section h2,
|
||||||
|
.markdown-section h3,
|
||||||
|
.markdown-section h4,
|
||||||
|
.markdown-section strong {
|
||||||
|
color: #657b83;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
.markdown-section a {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
.markdown-section h1 {
|
||||||
|
font-size: 2rem;
|
||||||
|
margin: 0 0 1rem;
|
||||||
|
}
|
||||||
|
.markdown-section h2 {
|
||||||
|
font-size: 1.75rem;
|
||||||
|
margin: 45px 0 0.8rem;
|
||||||
|
}
|
||||||
|
.markdown-section h3 {
|
||||||
|
font-size: 1.5rem;
|
||||||
|
margin: 40px 0 0.6rem;
|
||||||
|
}
|
||||||
|
.markdown-section h4 {
|
||||||
|
font-size: 1.25rem;
|
||||||
|
}
|
||||||
|
.markdown-section h5 {
|
||||||
|
font-size: 1rem;
|
||||||
|
}
|
||||||
|
.markdown-section h6 {
|
||||||
|
color: #777;
|
||||||
|
font-size: 1rem;
|
||||||
|
}
|
||||||
|
.markdown-section figure,
|
||||||
|
.markdown-section p,
|
||||||
|
.markdown-section ul,
|
||||||
|
.markdown-section ol {
|
||||||
|
margin: 1.2em 0;
|
||||||
|
}
|
||||||
|
.markdown-section p,
|
||||||
|
.markdown-section ul,
|
||||||
|
.markdown-section ol {
|
||||||
|
line-height: 1.6rem;
|
||||||
|
word-spacing: 0.05rem;
|
||||||
|
}
|
||||||
|
.markdown-section ul,
|
||||||
|
.markdown-section ol {
|
||||||
|
padding-left: 1.5rem;
|
||||||
|
}
|
||||||
|
.markdown-section blockquote {
|
||||||
|
border-left: 4px solid var(--theme-color, #ea6f5a);
|
||||||
|
color: #858585;
|
||||||
|
margin: 2em 0;
|
||||||
|
padding-left: 20px;
|
||||||
|
}
|
||||||
|
.markdown-section blockquote p {
|
||||||
|
font-weight: 600;
|
||||||
|
margin-left: 0;
|
||||||
|
}
|
||||||
|
.markdown-section iframe {
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
.markdown-section em {
|
||||||
|
color: #7f8c8d;
|
||||||
|
}
|
||||||
|
.markdown-section code {
|
||||||
|
background-color: #282828;
|
||||||
|
border-radius: 2px;
|
||||||
|
color: #aaaaaa;
|
||||||
|
font-family: 'Roboto Mono', Monaco, courier, monospace;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
margin: 0 2px;
|
||||||
|
padding: 3px 5px;
|
||||||
|
white-space: pre-wrap;
|
||||||
|
}
|
||||||
|
.markdown-section pre {
|
||||||
|
-moz-osx-font-smoothing: initial;
|
||||||
|
-webkit-font-smoothing: initial;
|
||||||
|
background-color: #282828;
|
||||||
|
font-family: 'Roboto Mono', Monaco, courier, monospace;
|
||||||
|
line-height: 1.5rem;
|
||||||
|
margin: 1.2em 0;
|
||||||
|
overflow: auto;
|
||||||
|
padding: 0 1.4rem;
|
||||||
|
position: relative;
|
||||||
|
word-wrap: normal;
|
||||||
|
}
|
||||||
|
/* code highlight */
|
||||||
|
.token.comment,
|
||||||
|
.token.prolog,
|
||||||
|
.token.doctype,
|
||||||
|
.token.cdata {
|
||||||
|
color: #8e908c;
|
||||||
|
}
|
||||||
|
.token.namespace {
|
||||||
|
opacity: 0.7;
|
||||||
|
}
|
||||||
|
.token.boolean,
|
||||||
|
.token.number {
|
||||||
|
color: #c76b29;
|
||||||
|
}
|
||||||
|
.token.punctuation {
|
||||||
|
color: #525252;
|
||||||
|
}
|
||||||
|
.token.property {
|
||||||
|
color: #c08b30;
|
||||||
|
}
|
||||||
|
.token.tag {
|
||||||
|
color: #2973b7;
|
||||||
|
}
|
||||||
|
.token.string {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
}
|
||||||
|
.token.selector {
|
||||||
|
color: #6679cc;
|
||||||
|
}
|
||||||
|
.token.attr-name {
|
||||||
|
color: #2973b7;
|
||||||
|
}
|
||||||
|
.token.entity,
|
||||||
|
.token.url,
|
||||||
|
.language-css .token.string,
|
||||||
|
.style .token.string {
|
||||||
|
color: #22a2c9;
|
||||||
|
}
|
||||||
|
.token.attr-value,
|
||||||
|
.token.control,
|
||||||
|
.token.directive,
|
||||||
|
.token.unit {
|
||||||
|
color: var(--theme-color, #ea6f5a);
|
||||||
|
}
|
||||||
|
.token.keyword {
|
||||||
|
color: #e96900;
|
||||||
|
}
|
||||||
|
.token.statement,
|
||||||
|
.token.regex,
|
||||||
|
.token.atrule {
|
||||||
|
color: #22a2c9;
|
||||||
|
}
|
||||||
|
.token.placeholder,
|
||||||
|
.token.variable {
|
||||||
|
color: #3d8fd1;
|
||||||
|
}
|
||||||
|
.token.deleted {
|
||||||
|
text-decoration: line-through;
|
||||||
|
}
|
||||||
|
.token.inserted {
|
||||||
|
border-bottom: 1px dotted #202746;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
.token.italic {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.token.important,
|
||||||
|
.token.bold {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
.token.important {
|
||||||
|
color: #c94922;
|
||||||
|
}
|
||||||
|
.token.entity {
|
||||||
|
cursor: help;
|
||||||
|
}
|
||||||
|
.markdown-section pre > code {
|
||||||
|
-moz-osx-font-smoothing: initial;
|
||||||
|
-webkit-font-smoothing: initial;
|
||||||
|
background-color: #282828;
|
||||||
|
border-radius: 2px;
|
||||||
|
color: #657b83;
|
||||||
|
display: block;
|
||||||
|
font-family: 'Roboto Mono', Monaco, courier, monospace;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
line-height: inherit;
|
||||||
|
margin: 0 2px;
|
||||||
|
max-width: inherit;
|
||||||
|
overflow: inherit;
|
||||||
|
padding: 2.2em 5px;
|
||||||
|
white-space: inherit;
|
||||||
|
}
|
||||||
|
.markdown-section code::after,
|
||||||
|
.markdown-section code::before {
|
||||||
|
letter-spacing: 0.05rem;
|
||||||
|
}
|
||||||
|
code .token {
|
||||||
|
-moz-osx-font-smoothing: initial;
|
||||||
|
-webkit-font-smoothing: initial;
|
||||||
|
min-height: 1.5rem;
|
||||||
|
}
|
||||||
|
pre::after {
|
||||||
|
color: #ccc;
|
||||||
|
content: attr(data-lang);
|
||||||
|
font-size: 0.6rem;
|
||||||
|
font-weight: 600;
|
||||||
|
height: 15px;
|
||||||
|
line-height: 15px;
|
||||||
|
padding: 5px 10px 0;
|
||||||
|
position: absolute;
|
||||||
|
right: 0;
|
||||||
|
text-align: right;
|
||||||
|
top: 0;
|
||||||
|
}
|
||||||
|
.markdown-section p.tip {
|
||||||
|
background-color: #282828;
|
||||||
|
color: #657b83;
|
||||||
|
}
|
||||||
|
input[type='search'] {
|
||||||
|
background: #4f4f4f;
|
||||||
|
border-color: #4f4f4f;
|
||||||
|
color: #c8c8c8;
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue