vuepress testing

110 changed files with 724 additions and 3 deletions
--- a/.gitignore
+++ b/.gitignore
@ -73,3 +73,7 @@ id_rsa_*

 # python things
 __pycache__
+
+# doc things
+dist
+node_modules
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@ -0,0 +1,43 @@
+module.exports = {
+  title: 'QMK Firmware Documentation',
+  description: 'Quantum Mechanical Keyboard Firmware Documentation.',
+  markdown: {
+    lineNumbers: true
+  },
+  themeConfig: {
+    displayAllHeaders: true,
+    docsDir: 'docs',
+    editLinks: true,
+    editLinkText: 'Suggest an improvement to this page!',
+    lastUpdated: 'Last Updated',
+    logo: '/favicon.png',
+    repo: 'qmk/qmk_api',
+    repoLabel: 'Fork',
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Chat', link: 'https://discord.gg/V5Trhu2' },
+    ],
+    sidebar: [
+      'newbs',
+      '/',
+      'faq',
+      'detailed_guides',
+      'reference',
+      'features',
+      'makers_modders',
+      'deeper_understanding',
+      'other_topics',
+      'qmk_internals'
+    ]
+  },
+  locales: {
+    '/': {
+      lang: 'en-US'
+    },
+    '/zh/': {
+      lang: 'zh-CN',
+      title: 'QMK鍵盤固件',
+      description: 'QMK鍵盤固件'
+    }
+  }
+}
--- a/docs/.vuepress/public/color-wheel.svg
+++ b/docs/.vuepress/public/color-wheel.svg
@ -0,0 +1,441 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Generator: Adobe Illustrator 15.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg
+    xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+    xmlns="http://www.w3.org/2000/svg"
+    xmlns:dc="http://purl.org/dc/elements/1.1/"
+    xmlns:ns1="http://sozi.baierouge.fr"
+    xmlns:cc="http://web.resource.org/cc/"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+    id="Layer_1"
+    enable-background="new 0 0 360 360"
+    xml:space="preserve"
+    viewBox="0 0 360 360"
+    version="1.1"
+    y="0px"
+    x="0px"
+  >
+<g
+    >
+</g
+  >
+<g
+    >
+	<g
+      >
+		<path
+          d="m193.8 167.46l113.52-113.89c-23.457-23.36-50.2-38.727-82.193-47.23l-41.313 155.45c3.15 0.84 7.66 3.37 9.98 5.67z"
+          fill="#E0C3D3"
+      />
+		<path
+          d="m209.95 151.26l97.367-97.688c-23.457-23.36-50.2-38.727-82.193-47.23l-35.43 133.29c7.71 1.86 14.76 5.91 20.25 11.63z"
+          fill="#E0A0C3"
+      />
+		<path
+          d="m225.94 135.21l81.375-81.643c-23.457-23.36-50.2-38.727-82.193-47.23l-29.61 111.4c11.55 2.89 22.11 8.95 30.42 17.47z"
+          fill="#E080B5"
+      />
+		<path
+          d="m241.95 119.15l65.369-65.585c-23.457-23.36-50.2-38.727-82.193-47.23l-23.784 89.491c15.38 3.919 29.46 12.004 40.6 23.324z"
+          fill="#E061A7"
+      />
+		<path
+          d="m257.95 103.1l49.371-49.533c-23.457-23.36-50.2-38.727-82.193-47.23l-17.962 67.589c19.22 4.944 36.82 15.052 50.78 29.174z"
+          fill="#E04198"
+      />
+		<path
+          d="m273.95 87.05l33.373-33.482c-23.457-23.36-50.2-38.727-82.193-47.23l-12.142 45.687c23.07 5.968 44.18 18.099 60.96 35.025z"
+          fill="#E0228B"
+      />
+		<path
+          d="m289.94 70.999l17.375-17.431c-23.457-23.36-50.2-38.728-82.193-47.231l-6.321 23.784c26.91 6.994 51.54 21.148 71.13 40.878z"
+          fill="#E10071"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m174.73 162.13c2.934-0.792 6.094-0.876 8.876-0.292l41-155.36c-31.994-8.502-61.625-8.332-93.483 0.274l42.101 155.85c-0.01-0.02 1.13-0.37 1.5-0.47z"
+          fill="#FFD9D9"
+      />
+		<path
+          d="m168.93 139.99c6.926-1.871 14.036-1.906 20.556-0.349l35.12-133.16c-31.994-8.502-61.625-8.332-93.483 0.274l36.127 133.73c0.95-0.27 1.19-0.36 1.67-0.49z"
+          fill="#FFB6B6"
+      />
+		<path
+          d="m163.03 118.12c10.904-2.946 22.03-2.917 32.267-0.373l29.31-111.27c-31.994-8.502-61.625-8.332-93.483 0.274l30.218 111.86c0.96-0.27 1.19-0.36 1.68-0.49z"
+          fill="#FF8F8F"
+      />
+		<path
+          d="m157.12 96.243c14.884-4.021 30.029-3.944 43.982-0.413l23.51-89.354c-31.994-8.502-61.625-8.332-93.483 0.274l24.304 89.968c0.96-0.268 1.2-0.344 1.69-0.475z"
+          fill="#FF6E6E"
+      />
+		<path
+          d="m151.21 74.369c18.863-5.096 38.024-4.964 55.695-0.446l17.71-67.447c-31.994-8.502-61.625-8.332-93.483 0.274l18.395 68.094c0.96-0.267 1.2-0.344 1.69-0.475z"
+          fill="#FF4848"
+      />
+		<path
+          d="m145.06 52.56c22.919-6.191 46.298-6.016 67.745-0.456l11.81-45.628c-31.994-8.502-61.625-8.332-93.483 0.274l12.484 46.214c0.97-0.263 1.13-0.317 1.45-0.404z"
+          fill="#FF2424"
+      />
+		<path
+          d="m139.15 30.685c26.906-7.269 54.312-7.036 79.48-0.483l5.978-23.726c-31.994-8.502-61.625-8.332-93.483 0.274l6.575 24.34c0.97-0.262 1.13-0.318 1.45-0.405z"
+          fill="#FF0000"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m173.23 162.6l-42.1-155.85c-31.858 8.606-56.824 23.185-80.185 46.64l114.57 114.36c2.08-2.33 4.86-4.17 7.71-5.15z"
+          fill="#FFEBD9"
+      />
+		<path
+          d="m167.25 140.48l-36.12-133.73c-31.858 8.606-56.824 23.185-80.185 46.64l98.442 98.288c4.77-5.09 11.17-9.11 17.86-11.2z"
+          fill="#FFD7B3"
+      />
+		<path
+          d="m161.34 118.61l-30.21-111.86c-31.858 8.606-56.824 23.185-80.185 46.64l82.386 82.283c7.49-7.82 17.47-13.93 28.01-17.06z"
+          fill="#FFC48F"
+      />
+		<path
+          d="m155.43 96.719l-24.3-89.969c-31.858 8.606-56.824 23.185-80.185 46.64l66.336 66.282c10.2-10.55 23.74-18.78 38.15-22.951z"
+          fill="#FFB26C"
+      />
+		<path
+          d="m149.52 74.845l-18.39-68.095c-31.858 8.606-56.824 23.185-80.185 46.64l50.287 50.283c12.91-13.273 30.02-23.612 48.29-28.825z"
+          fill="#FF9F48"
+      />
+		<path
+          d="m143.61 52.964l-12.48-46.214c-31.858 8.606-56.824 23.185-80.185 46.64l34.05 34.204c15.705-16.028 35.495-28.198 58.615-34.63z"
+          fill="#FF8C24"
+      />
+		<path
+          d="m137.7 31.091l-6.575-24.34c-31.858 8.606-56.824 23.185-80.185 46.64l17.99 18.216c18.435-18.762 41.795-33.041 68.775-40.516z"
+          fill="#FF8000"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m166.24 167.56l-114.82-114.3c-23.36 23.457-36.884 48.514-45.386 80.507l155.98 41.453c0.85-3.15 1.92-5.35 4.23-7.66z"
+          fill="#FFFED9"
+      />
+		<path
+          d="m149.96 151.35l-98.535-98.09c-23.36 23.457-36.884 48.514-45.386 80.507l133.85 35.573c1.8-6.74 5.26-12.94 10.07-17.99z"
+          fill="#FFFDB3"
+      />
+		<path
+          d="m133.9 135.37l-82.475-82.11c-23.36 23.457-36.884 48.514-45.386 80.507l111.95 29.753c2.82-10.58 8.31-20.29 15.91-28.15z"
+          fill="#FFFC8F"
+      />
+		<path
+          d="m117.84 119.37l-66.415-66.11c-23.36 23.457-36.884 48.514-45.386 80.507l90.037 23.929c3.845-14.42 11.364-27.64 21.764-38.33z"
+          fill="#FFFB6C"
+      />
+		<path
+          d="m101.78 103.39l-50.355-50.13c-23.36 23.457-36.884 48.514-45.386 80.507l68.136 18.108c4.869-18.26 14.403-34.99 27.605-48.49z"
+          fill="#FFFA48"
+      />
+		<path
+          d="m85.716 87.398l-34.291-34.138c-23.36 23.457-36.884 48.514-45.386 80.507l46.235 12.288c5.893-22.09 17.445-42.34 33.442-58.662z"
+          fill="#FFF924"
+      />
+		<path
+          d="m69.657 71.411l-18.232-18.151c-23.36 23.457-36.884 48.514-45.386 80.507l24.334 6.468c6.917-25.93 20.488-49.694 39.284-68.829z"
+          fill="#FFFF00"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m162.13 185.27c-0.792-2.934-0.647-7.06-0.061-9.842l-155.89-41.15c-8.503 31.994-8.034 62.733 0.572 94.591l155.85-42.1c-0.02 0.01-0.37-1.13-0.47-1.5z"
+          fill="#EBFFD9"
+      />
+		<path
+          d="m139.99 191.07c-1.963-7.268-1.891-14.725-0.095-21.517l-133.72-35.27c-8.503 31.994-8.034 62.733 0.572 94.591l133.73-36.127c-0.27-0.96-0.36-1.19-0.49-1.67z"
+          fill="#D8FFB6"
+      />
+		<path
+          d="m118.12 196.98c-3.039-11.249-2.905-22.722-0.121-33.231l-111.82-29.47c-8.503 31.994-8.034 62.733 0.572 94.591l111.86-30.218c-0.27-0.96-0.36-1.19-0.49-1.67z"
+          fill="#C5FF92"
+      />
+		<path
+          d="m96.244 202.89c-4.114-15.228-3.942-30.725-0.169-44.949l-89.897-23.66c-8.503 31.994-8.034 62.733 0.572 94.591l89.968-24.304c-0.268-0.97-0.343-1.2-0.474-1.68z"
+          fill="#B1FF6C"
+      />
+		<path
+          d="m74.371 208.8c-5.189-19.208-4.962-38.724-0.201-56.666l-67.992-17.85c-8.503 31.994-8.034 62.733 0.572 94.591l68.094-18.395c-0.267-0.96-0.343-1.2-0.473-1.68z"
+          fill="#9DFF48"
+      />
+		<path
+          d="m52.563 214.95c-6.285-23.265-6.011-46.996-0.205-68.714l-46.18-11.96c-8.503 31.994-8.034 62.733 0.572 94.591l46.214-12.484c-0.263-0.97-0.315-1.12-0.401-1.44z"
+          fill="#8AFF24"
+      />
+		<path
+          d="m30.688 220.86c-7.362-27.251-7.029-55.011-0.229-80.452l-24.28-6.125c-8.503 31.994-8.034 62.733 0.572 94.591l24.34-6.575c-0.264-0.97-0.317-1.12-0.403-1.44z"
+          fill="#71FF00"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m162.6 186.77l-155.85 42.1c8.606 31.857 23.185 56.824 46.641 80.185l114.36-114.57c-2.33-2.09-4.17-4.87-5.15-7.72z"
+          fill="#DCFFDC"
+      />
+		<path
+          d="m140.48 192.75l-133.73 36.12c8.606 31.857 23.185 56.824 46.641 80.185l98.286-98.442c-5.1-4.78-9.11-11.18-11.2-17.87z"
+          fill="#B6FFB6"
+      />
+		<path
+          d="m118.61 198.66l-111.86 30.21c8.606 31.857 23.185 56.824 46.641 80.185l82.281-82.387c-7.82-7.49-13.93-17.47-17.06-28.01z"
+          fill="#92FF92"
+      />
+		<path
+          d="m96.719 204.57l-89.969 24.3c8.606 31.857 23.185 56.824 46.641 80.185l66.28-66.336c-10.55-10.2-18.78-23.74-22.951-38.15z"
+          fill="#6EFF6E"
+      />
+		<path
+          d="m74.845 210.48l-68.095 18.39c8.606 31.857 23.185 56.824 46.641 80.185l50.281-50.287c-13.274-12.92-23.614-30.02-28.825-48.29z"
+          fill="#4AFF4A"
+      />
+		<path
+          d="m52.964 216.39l-46.214 12.48c8.606 31.857 23.185 56.824 46.641 80.185l34.202-34.049c-16.028-15.71-28.198-35.5-34.629-58.62z"
+          fill="#27FF27"
+      />
+		<path
+          d="m31.091 222.3l-24.34 6.575c8.606 31.857 23.185 56.824 46.641 80.185l18.214-17.989c-18.763-18.43-33.043-41.79-40.515-68.77z"
+          fill="#00FF00"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m167.59 193.87l-114.31 114.78c23.455 23.359 47.388 37.112 79.381 45.616l41.606-156.55c-3.16-0.85-4.37-1.55-6.68-3.85z"
+          fill="#DCFFED"
+      />
+		<path
+          d="m151.42 210.11l-98.14 98.54c23.455 23.359 47.388 37.112 79.381 45.616l35.721-134.41c-6.34-1.86-12.17-5.21-16.96-9.75z"
+          fill="#B6FFD9"
+      />
+		<path
+          d="m135.43 226.16l-82.15 82.49c23.455 23.359 47.388 37.112 79.381 45.616l29.9-112.51c-10.18-2.89-19.52-8.26-27.13-15.6z"
+          fill="#92FFC6"
+      />
+		<path
+          d="m119.43 242.22l-66.15 66.43c23.456 23.359 47.388 37.112 79.381 45.616l24.079-90.603c-14.02-3.92-26.87-11.31-37.31-21.45z"
+          fill="#6EFFB3"
+      />
+		<path
+          d="m103.44 258.28l-50.16 50.37c23.455 23.359 47.388 37.112 79.381 45.616l18.258-68.701c-17.86-4.95-34.22-14.35-47.48-27.29z"
+          fill="#4AFFA0"
+      />
+		<path
+          d="m87.451 274.34l-34.17 34.31c23.455 23.359 47.388 37.112 79.381 45.616l12.438-46.801c-21.69-5.97-41.58-17.4-57.649-33.13z"
+          fill="#27FF8D"
+      />
+		<path
+          d="m71.459 290.39l-18.179 18.26c23.455 23.359 47.388 37.112 79.381 45.616l6.618-24.9c-25.53-6.99-48.93-20.44-67.821-38.98z"
+          fill="#00FF80"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m173.85 197.82l-41.812 156.61c31.993 8.501 61.11 8.47 92.969-0.136l-42.101-155.85c-2.95 0.59-6.08 0.35-9.06-0.62z"
+          fill="#DCFFFE"
+      />
+		<path
+          d="m167.98 219.87l-35.941 134.56c31.993 8.501 61.11 8.47 92.969-0.136l-36.127-133.73c-6.82 1.57-14.22 1.29-20.9-0.69z"
+          fill="#B6FFFD"
+      />
+		<path
+          d="m162.15 241.77l-30.107 112.65c31.993 8.501 61.11 8.47 92.969-0.136l-30.219-111.86c-10.69 2.62-22.24 2.33-32.64-0.65z"
+          fill="#92FFFC"
+      />
+		<path
+          d="m156.32 263.68l-24.276 90.754c31.993 8.501 61.11 8.47 92.969-0.136l-24.305-89.969c-14.54 3.66-30.26 3.33-44.38-0.64z"
+          fill="#6EFFFB"
+      />
+		<path
+          d="m150.49 285.57l-18.446 68.856c31.993 8.501 61.11 8.47 92.969-0.136l-18.396-68.095c-18.41 4.7-38.28 4.34-56.12-0.63z"
+          fill="#4AFFFA"
+      />
+		<path
+          d="m144.7 307.61l-12.655 46.815c31.993 8.501 61.11 8.47 92.969-0.136l-12.484-46.215c-23.22 6.1-46.19 5.49-67.83-0.45z"
+          fill="#27FFF9"
+      />
+		<path
+          d="m138.88 329.52l-6.839 24.913c31.994 8.501 61.11 8.47 92.969-0.136l-6.575-24.341c-27.08 7.13-54.2 6.49-79.56-0.43z"
+          fill="#00FFFF"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m192.47 193.82c-2.109 1.906-5.088 3.48-8.022 4.273-0.373 0.101-1.527 0.377-1.533 0.354l42.101 155.85c31.857-8.606 57.647-23.407 81.009-46.862l-113.56-113.61z"
+          fill="#DCEFFF"
+      />
+		<path
+          d="m208.69 210.01c-4.857 4.652-11.156 8.255-18.107 10.133-0.485 0.131-0.729 0.176-1.699 0.42l36.127 133.73c31.857-8.606 57.647-23.407 81.009-46.862l-97.33-97.42z"
+          fill="#B6DEFF"
+      />
+		<path
+          d="m224.73 226.01c-7.572 7.374-17.307 13.052-28.233 16.004-0.486 0.131-0.732 0.17-1.701 0.42l30.219 111.86c31.857-8.606 57.647-23.407 81.009-46.862l-81.3-81.42z"
+          fill="#92CEFF"
+      />
+		<path
+          d="m240.78 242.02c-10.285 10.097-23.467 17.838-38.372 21.864-0.484 0.131-0.729 0.186-1.696 0.438l24.305 89.969c31.857-8.606 57.647-23.407 81.009-46.862l-65.25-65.41z"
+          fill="#6EBEFF"
+      />
+		<path
+          d="m208.31 285.76c-0.485 0.132-0.731 0.185-1.698 0.439l18.396 68.095c31.857-8.606 57.647-23.407 81.009-46.862l-49.444-49.336c-13 12.81-29.38 22.56-48.27 27.66z"
+          fill="#4AADFF"
+      />
+		<path
+          d="m213.98 307.7c-0.324 0.088-0.49 0.122-1.456 0.38l12.484 46.215c31.857-8.606 57.647-23.407 81.009-46.862l-33.533-33.371c-15.72 15.59-35.58 27.44-58.5 33.63z"
+          fill="#279EFF"
+      />
+		<path
+          d="m219.89 329.57c-0.325 0.088-0.491 0.121-1.457 0.38l6.575 24.341c31.857-8.606 57.647-23.407 81.009-46.862l-17.47-17.385c-18.43 18.34-41.75 32.27-68.65 39.53z"
+          fill="#0080FF"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m197.71 185.73c-0.843 3.153-2.941 5.768-5.242 8.083l113.97 113.5c23.359-23.456 39.325-47.987 47.829-79.98l-156.56-41.6z"
+          fill="#DCDCFF"
+      />
+		<path
+          d="m219.85 191.62c-2.041 6.976-5.889 13.329-11.148 18.372l97.727 97.328c23.359-23.456 39.325-47.987 47.829-79.98l-134.41-35.72z"
+          fill="#B6B6FF"
+      />
+		<path
+          d="m241.75 197.44c-3.064 10.814-8.936 20.677-16.995 28.538l81.675 81.342c23.359-23.456 39.325-47.987 47.829-79.98l-112.52-29.9z"
+          fill="#9292FF"
+      />
+		<path
+          d="m263.66 203.26c-4.089 14.652-11.976 28.037-22.837 38.716l65.61 65.343c23.359-23.456 39.325-47.987 47.829-79.98l-90.6-24.08z"
+          fill="#6E6EFF"
+      />
+		<path
+          d="m285.56 209.08c-5.112 18.491-15.019 35.392-28.682 48.887l49.554 49.352c23.359-23.456 39.325-47.987 47.829-79.98l-68.7-18.26z"
+          fill="#4A4AFF"
+      />
+		<path
+          d="m307.46 214.9c-6.137 22.329-18.063 42.745-34.525 59.06l33.496 33.358c23.359-23.456 39.325-47.987 47.829-79.98l-46.81-12.44z"
+          fill="#2727FF"
+      />
+		<path
+          d="m329.36 220.72c-7.161 26.167-21.104 50.1-40.368 69.23l17.438 17.366c23.359-23.456 39.325-47.987 47.829-79.98l-24.9-6.62z"
+          fill="#0000FF"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m198.44 177.09c0.588 2.949 0.342 6.08-0.624 9.056l156.61 41.813c8.501-31.994 8.47-61.111-0.136-92.969l-155.85 42.1z"
+          fill="#ECDCFF"
+      />
+		<path
+          d="m220.56 171.12c1.57 6.827 1.293 14.228-0.688 20.901l134.56 35.941c8.501-31.994 8.47-61.111-0.136-92.969l-133.73 36.13z"
+          fill="#D8B6FF"
+      />
+		<path
+          d="m242.43 165.21c2.612 10.689 2.32 22.245-0.657 32.643l112.65 30.108c8.501-31.994 8.47-61.111-0.136-92.969l-111.85 30.22z"
+          fill="#C492FF"
+      />
+		<path
+          d="m264.32 159.29c3.655 14.55 3.324 30.265-0.649 44.388l90.754 24.277c8.501-31.994 8.47-61.111-0.136-92.969l-89.96 24.3z"
+          fill="#B16EFF"
+      />
+		<path
+          d="m286.2 153.38c4.699 18.412 4.345 38.281-0.625 56.128l68.855 18.446c8.501-31.994 8.47-61.111-0.136-92.969l-68.1 18.39z"
+          fill="#9E4AFF"
+      />
+		<path
+          d="m308.08 147.47c6.088 23.216 5.471 46.185-0.464 67.83l46.814 12.655c8.501-31.994 8.47-61.111-0.136-92.969l-46.21 12.48z"
+          fill="#8B27FF"
+      />
+		<path
+          d="m329.95 141.56c7.131 27.078 6.49 54.192-0.435 79.554l24.911 6.84c8.501-31.994 8.47-61.111-0.136-92.969l-24.34 6.58z"
+          fill="#8000FF"
+      />
+	</g
+    >
+	<g
+      >
+		<path
+          d="m198.09 175.56c0.101 0.374 0.377 1.528 0.354 1.534l155.85-42.101c-8.606-31.858-23.408-57.649-46.862-81.009l-113.63 113.48c1.9 2.11 3.5 5.16 4.29 8.1z"
+          fill="#FEDCFF"
+      />
+		<path
+          d="m220.14 169.42c0.131 0.486 0.176 0.729 0.42 1.699l133.73-36.126c-8.606-31.858-23.407-57.648-46.862-81.009l-97.479 97.275c4.61 4.84 8.32 11.25 10.19 18.16z"
+          fill="#FDB6FF"
+      />
+		<path
+          d="m242.01 163.51c0.131 0.484 0.169 0.729 0.419 1.697l111.86-30.218c-8.606-31.858-23.408-57.649-46.862-81.009l-81.486 81.231c7.34 7.56 13.13 17.41 16.07 28.3z"
+          fill="#FC92FF"
+      />
+		<path
+          d="m263.89 157.6c0.13 0.484 0.185 0.725 0.438 1.692l89.969-24.304c-8.606-31.858-23.408-57.649-46.862-81.009l-65.48 65.173c10.06 10.28 17.91 23.57 21.93 38.45z"
+          fill="#FB6EFF"
+      />
+		<path
+          d="m285.76 151.69c0.131 0.483 0.183 0.724 0.438 1.69l68.095-18.395c-8.606-31.858-23.408-57.649-46.862-81.009l-49.482 49.121c12.79 13 22.71 29.74 27.8 48.6z"
+          fill="#FA4AFF"
+      />
+		<path
+          d="m307.7 146.03c0.087 0.321 0.12 0.48 0.378 1.447l46.215-12.484c-8.606-31.858-23.408-57.649-46.862-81.009l-33.484 33.07c15.59 15.719 27.55 36.039 33.74 58.969z"
+          fill="#F927FF"
+      />
+		<path
+          d="m329.58 140.12c0.086 0.321 0.118 0.48 0.377 1.446l24.341-6.575c-8.606-31.858-23.52-58.061-46.974-81.421l-17.375 17.432c18.32 18.435 32.35 42.199 39.62 69.109z"
+          fill="#FF00FF"
+      />
+	</g
+    >
+</g
+  >
+<metadata
+    ><rdf:RDF
+      ><cc:Work
+        ><dc:format
+          >image/svg+xml</dc:format
+        ><dc:type
+            rdf:resource="http://purl.org/dc/dcmitype/StillImage"
+        /><cc:license
+            rdf:resource="http://creativecommons.org/licenses/publicdomain/"
+        /><dc:publisher
+          ><cc:Agent
+              rdf:about="http://openclipart.org/"
+            ><dc:title
+              >Openclipart</dc:title
+            ></cc:Agent
+          ></dc:publisher
+        ></cc:Work
+      ><cc:License
+          rdf:about="http://creativecommons.org/licenses/publicdomain/"
+        ><cc:permits
+            rdf:resource="http://creativecommons.org/ns#Reproduction"
+        /><cc:permits
+            rdf:resource="http://creativecommons.org/ns#Distribution"
+        /><cc:permits
+            rdf:resource="http://creativecommons.org/ns#DerivativeWorks"
+        /></cc:License
+      ></rdf:RDF
+    ></metadata
+  ></svg
+>
--- a/docs/.vuepress/public/favicon.ico
+++ b/docs/.vuepress/public/favicon.ico
--- a/docs/README.md
+++ b/docs/README.md
@ -1,5 +1,7 @@
 # Quantum Mechanical Keyboard Firmware

+[[toc]]
+
 [![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
 [![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
 [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
--- a/docs/arm_debugging.md
+++ b/docs/arm_debugging.md
@ -1,5 +1,7 @@
 # ARM Debugging usign Eclipse

+[[toc]]
+
 This page describes how to setup debugging for ARM MCUs using an SWD adapter and open-source/free tools. In this guide we will install GNU MCU Eclipse IDE for C/C++ Developers and OpenOCD together with all the necessary dependencies.

 This guide is catered towards advance users and assumes you can compile an ARM compatible keyboard on your machine using the MAKE flow.
@ -84,4 +86,4 @@ Reset your keyboard.
 Press the bug icon and if all goes well you should soon find yourself in the debug perspective. Here the program counter will pause at the beginning of the main function and way for you to press Play. Most of the features of all debuggers work on ARM MCUs but for exact details google is your friend!


-Happy debugging!
+Happy debugging!
--- a/docs/becoming_a_qmk_collaborator.md
+++ b/docs/becoming_a_qmk_collaborator.md
@ -1,5 +1,7 @@
 # Becoming a QMK Collaborator

+[[toc]]
+
 A QMK collaborator is a keyboard maker or designer that is interested in helping QMK grow and fully support their keyboard(s), and encouraging their users and customers to submit features, ideas, and keymaps. We're always looking to add more keyboards and collaborators, but we ask that they fulfill these requirements:

 * **Have a PCB available for sale.** Unfortunately there's just too much variation and complications with handwired keyboards.
--- a/docs/cli.md
+++ b/docs/cli.md
@ -1,5 +1,7 @@
 # QMK CLI

+[[toc]]
+
 This page describes how to setup and use the QMK CLI.

 # Overview
--- a/docs/coding_conventions_c.md
+++ b/docs/coding_conventions_c.md
@ -1,5 +1,7 @@
 # Coding Conventions (C)

+[[toc]]
+
 Most of our style is pretty easy to pick up on, but right now it's not entirely consistent. You should match the style of the code surrounding your change, but if that code is inconsistent or unclear use the following guidelines:

 * We indent using four (4) spaces (soft tabs)
--- a/docs/coding_conventions_python.md
+++ b/docs/coding_conventions_python.md
@ -1,5 +1,7 @@
 # Coding Conventions (Python)

+[[toc]]
+
 Most of our style follows PEP8 with some local modifications to make things less nit-picky. 

 * We target Python 3.5 for compatability with all supported platforms.
--- a/docs/compatible_microcontrollers.md
+++ b/docs/compatible_microcontrollers.md
@ -1,5 +1,7 @@
 # Atmel AVR

+[[toc]]
+
 QMK should run on any Atmel AVR processor with enough Flash. It has been tested on the following:

 * ATmega32U4 ([PJRC Teensy 2.0](http://www.pjrc.com/teensy/))
--- a/docs/config_options.md
+++ b/docs/config_options.md
@ -1,5 +1,7 @@
 # Configuring QMK

+[[toc]]
+
 QMK is nearly infinitely configurable. Wherever possible we err on the side of allowing users to customize their keyboard, even at the expense of code size. That level of flexibility makes for a daunting configuration experience, however.

 There are two main types of configuration files in QMK- `config.h` and `rules.mk`. These files exist at various levels in QMK and all files of the same type are combined to build the final configuration. The levels, from lowest priority to highest priority, are:
--- a/docs/contributing.md
+++ b/docs/contributing.md
@ -1,5 +1,7 @@
 # How to Contribute

+[[toc]]
+
 👍🎉 First off, thanks for taking the time to read this and contribute! 🎉👍

 Third-party contributions help us grow and improve QMK. We want to make the pull request and contribution process useful and easy for both contributors and maintainers. To this end we've put together some guidelines for contributors to help your pull request be accepted without major changes.
--- a/docs/custom_quantum_functions.md
+++ b/docs/custom_quantum_functions.md
@ -1,5 +1,7 @@
 # How to Customize Your Keyboard's Behavior

+[[toc]]
+
 For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations.

 This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.md) will help you understand what is going on at a more fundamental level.
--- a/docs/deeper_understanding.md
+++ b/docs/deeper_understanding.md
@ -0,0 +1 @@
+# For a Deeper Understanding
--- a/docs/detailed_guides.md
+++ b/docs/detailed_guides.md
@ -0,0 +1,3 @@
+# Detailed Guides
+
+* TBD
--- a/docs/documentation_best_practices.md
+++ b/docs/documentation_best_practices.md
@ -1,5 +1,7 @@
 # Documentation Best Practices

+[[toc]]
+
 This page exists to document best practices when writing documentation for QMK. Following these guidelines will help to keep a consistent tone and style, which will in turn help other people more easily understand QMK.

 # Page Opening
--- a/docs/documentation_templates.md
+++ b/docs/documentation_templates.md
@ -1,5 +1,7 @@
 # Documentation Templates

+[[toc]]
+
 This page documents the templates you should use when submitting new Keymaps and Keyboards to QMK.

 ## Keymap `readme.md` Template
--- a/docs/faq.md
+++ b/docs/faq.md
@ -1,5 +1,7 @@
 # Frequently Asked Questions

+[[toc]]
+
 * [General](faq_general.md)
 * [Building or Compiling QMK](faq_build.md)
 * [Debugging and Troubleshooting QMK](faq_debug.md)
--- a/docs/faq_build.md
+++ b/docs/faq_build.md
@ -1,5 +1,7 @@
 # Frequently Asked Build Questions

+[[toc]]
+
 This page covers questions about building QMK. If you haven't yet done so, you should read the [Build Environment Setup](getting_started_build_tools.md) and [Make Instructions](getting_started_make_guide.md) guides.

 ## Can't Program on Linux
--- a/docs/faq_debug.md
+++ b/docs/faq_debug.md
@ -1,5 +1,7 @@
 # Debugging FAQ

+[[toc]]
+
 This page details various common questions people have about troubleshooting their keyboards.

 # Debug Console
--- a/docs/faq_general.md
+++ b/docs/faq_general.md
@ -1,5 +1,7 @@
 # Frequently Asked Questions

+[[toc]]
+
 ## What is QMK?

 [QMK](https://github.com/qmk), short for Quantum Mechanical Keyboard, is a group of people building tools for custom keyboards. We started with the [QMK firmware](https://github.com/qmk/qmk_firmware), a heavily modified fork of [TMK](https://github.com/tmk/tmk_keyboard).
--- a/docs/faq_keymap.md
+++ b/docs/faq_keymap.md
@ -1,5 +1,7 @@
 # Keymap FAQ

+[[toc]]
+
 This page covers questions people often have about keymaps. If you haven't you should read [Keymap Overview](keymap.md) first.

 ## What Keycodes Can I Use?
--- a/docs/feature_advanced_keycodes.md
+++ b/docs/feature_advanced_keycodes.md
@ -1,5 +1,7 @@
 # Advanced Keycodes

+[[toc]]
+
 Your keymap can include keycodes that are more advanced than normal, for example keys that switch layers or send modifiers when held, but send regular keycodes when tapped. This page documents the functions that are available to you.

 ## Assigning Custom Names
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@ -1,5 +1,7 @@
 # Audio

+[[toc]]
+
 Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any AVR keyboard that allows access to certain PWM-capable pins, you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.

 Up to two simultaneous audio voices are supported, one driven by timer 1 and another driven by timer 3.  The following pins can be defined as audio outputs in config.h:
--- a/docs/feature_auto_shift.md
+++ b/docs/feature_auto_shift.md
@ -1,5 +1,7 @@
 # Auto Shift: Why Do We Need a Shift Key?

+[[toc]]
+
 Tap a key and you get its character. Tap a key, but hold it *slightly* longer
 and you get its shifted state. Voilà! No shift key needed!

--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@ -1,5 +1,7 @@
 # Backlighting

+[[toc]]
+
 Many keyboards support backlit keys by way of individual LEDs placed through or underneath the keyswitches. QMK is able to control the brightness of these LEDs by switching them on and off rapidly in a certain ratio, a technique known as *Pulse Width Modulation*, or PWM. By altering the duty cycle of the PWM signal, it creates the illusion of dimming.

 The MCU can only supply so much current to its GPIO pins. Instead of powering the backlight directly from the MCU, the backlight pin is connected to a transistor or MOSFET that switches the power to the LEDs.
--- a/docs/feature_bluetooth.md
+++ b/docs/feature_bluetooth.md
@ -1,5 +1,7 @@
 # Bluetooth

+[[toc]]
+
 ## Bluetooth Known Supported Hardware

 Currently Bluetooth support is limited to AVR based chips. For Bluetooth 2.1 Qmk has support for RN-42 HID Firmware and Bluefruit EZ Key the later of which is not produced anymore. For more recent BLE protocols currently only the Adafruit Bluefruit SPI friend is directly supported. BLE is needed to connect to iOS devices. Note iOS does not support Mouse Input.
--- a/docs/feature_bootmagic.md
+++ b/docs/feature_bootmagic.md
@ -1,5 +1,7 @@
 # Bootmagic

+[[toc]]
+
 There are three separate but related features that allow you to change the behavior of your keyboard without reflashing. While each of them have similar functionality, it is accessed in different ways depending on how your keyboard is configured.

 **Bootmagic** is a system for configuring your keyboard while it initializes. To trigger a Bootmagic command, hold down the Bootmagic key and one or more command keys.
--- a/docs/feature_combo.md
+++ b/docs/feature_combo.md
@ -1,5 +1,7 @@
 # Combos

+[[toc]]
+
 The Combo feature is a chording type solution for adding custom actions.  It lets you hit multiple keys at once and produce a different effect.  For instance, hitting `A` and `S` within the tapping term would hit `ESC` instead, or have it perform even more complex tasks.

 To enable this feature, yu need to add `COMBO_ENABLE = yes` to your `rules.mk`.
--- a/docs/feature_command.md
+++ b/docs/feature_command.md
@ -1,5 +1,7 @@
 # Command

+[[toc]]
+
 Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](feature_bootmagic.md). There is a lot of overlap between this functionality and the [Bootmagic Keycodes](feature_bootmagic.md#keycodes). Wherever possible we encourage you to use that feature instead of Command.

 On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`:
--- a/docs/feature_debounce_type.md
+++ b/docs/feature_debounce_type.md
@ -1,5 +1,7 @@
 # Debounce algorithm

+[[toc]]
+
 QMK supports multiple debounce algorithms through its debounce API.

 The logic for which debounce method called is below. It checks various defines that you have set in rules.mk
--- a/docs/feature_dynamic_macros.md
+++ b/docs/feature_dynamic_macros.md
@ -1,5 +1,7 @@
 # Dynamic Macros: Record and Replay Macros in Runtime

+[[toc]]
+
 QMK supports temporary macros created on the fly. We call these Dynamic Macros. They are defined by the user from the keyboard and are lost when the keyboard is unplugged or otherwise rebooted.

 You can store one or two macros and they may have a combined total of 128 keypresses. You can increase this size at the cost of RAM.
--- a/docs/feature_encoders.md
+++ b/docs/feature_encoders.md
@ -1,5 +1,7 @@
 # Encoders

+[[toc]]
+
 Basic encoders are supported by adding this to your `rules.mk`:

    ENCODER_ENABLE = yes
--- a/docs/feature_grave_esc.md
+++ b/docs/feature_grave_esc.md
@ -1,5 +1,7 @@
 # Grave Escape

+[[toc]]
+
 If you're using a 60% keyboard, or any other layout with no F-row, you will have noticed that there is no dedicated Escape key. Grave Escape is a feature that allows you to share the grave key (<code>&#96;</code> and `~`) with Escape.

 ## Usage
--- a/docs/feature_haptic_feedback.md
+++ b/docs/feature_haptic_feedback.md
@ -1,5 +1,7 @@
 # Haptic Feedback

+[[toc]]
+
 ## Haptic feedback rules.mk options

 The following options are currently available for haptic feedback in `rule.mk`:
--- a/docs/feature_hd44780.md
+++ b/docs/feature_hd44780.md
@ -1,5 +1,7 @@
 # HD44780 LCD Displays

+[[toc]]
+
 This is an integration of Peter Fleury's LCD library. This page will explain the basics. [For in depth documentation visit his page.](http://homepage.hispeed.ch/peterfleury/doxygen/avr-gcc-libraries/group__pfleury__lcd.html)

 You can enable support for HD44780 Displays by setting the `HD44780_ENABLE` flag in your keyboards `rules.mk` to yes. This will use about 400 KB of extra space.
--- a/docs/feature_key_lock.md
+++ b/docs/feature_key_lock.md
@ -1,5 +1,7 @@
 # Key Lock

+[[toc]]
+
 Sometimes you may find yourself needing to hold down a specific key for a long period of time. Key Lock holds down the next key you press for you. Press it again, and it will be released.

 Let's say you need to type in ALL CAPS for a few sentences. Hit `KC_LOCK`, and then Shift. Now, Shift will be considered held until you tap it again. You can think of Key Lock as Caps Lock, but supercharged.
--- a/docs/feature_layouts.md
+++ b/docs/feature_layouts.md
@ -1,5 +1,7 @@
 # Layouts: Using a Keymap with Multiple Keyboards

+[[toc]]
+
 The `layouts/` folder contains different physical key layouts that can apply to different keyboards.

 ```
--- a/docs/feature_leader_key.md
+++ b/docs/feature_leader_key.md
@ -1,5 +1,7 @@
 # The Leader Key: A New Kind of Modifier

+[[toc]]
+
 If you've ever used Vim, you know what a Leader key is. If not, you're about to discover a wonderful concept. :) Instead of hitting Alt+Shift+W for example (holding down three keys at the same time), what if you could hit a _sequence_ of keys instead? So you'd hit our special modifier (the Leader key), followed by W and then C (just a rapid succession of keys), and something would happen.

 That's what `KC_LEAD` does. Here's an example:
--- a/docs/feature_led_matrix.md
+++ b/docs/feature_led_matrix.md
@ -1,5 +1,7 @@
 # LED Matrix Lighting

+[[toc]]
+
 This feature allows you to use LED matrices driven by external drivers. It hooks into the backlight system so you can use the same keycodes as backlighting to control it.

 If you want to use RGB LED's you should use the [RGB Matrix Subsystem](feature_rgb_matrix.md) instead.
--- a/docs/feature_macros.md
+++ b/docs/feature_macros.md
@ -1,5 +1,7 @@
 # Macros

+[[toc]]
+
 Macros allow you to send multiple keystrokes when pressing just one key. QMK has a number of ways to define and use macros. These can do anything you want: type common phrases for you, copypasta, repetitive game movements, or even help you code.

 !> **Security Note**: While it is possible to use macros to send passwords, credit card numbers, and other sensitive information it is a supremely bad idea to do so. Anyone who gets a hold of your keyboard will be able to access that information by opening a text editor.
--- a/docs/feature_mouse_keys.md
+++ b/docs/feature_mouse_keys.md
@ -1,5 +1,7 @@
 # Mouse keys

+[[toc]]
+
 Mouse keys is a feature that allows you to emulate a mouse using your keyboard. You can move the pointer at different speeds, press 5 buttons and scroll in 8 directions.

 ## Adding mouse keys to your keyboard
--- a/docs/feature_oled_driver.md
+++ b/docs/feature_oled_driver.md
@ -1,5 +1,7 @@
 # OLED Driver

+[[toc]]
+
 ## OLED Supported Hardware

 OLED modules using SSD1306 or SH1106 driver ICs, communicating over I2C.
--- a/docs/feature_pointing_device.md
+++ b/docs/feature_pointing_device.md
@ -1,5 +1,7 @@
 ## Pointing Device

+[[toc]]
+
 Pointing Device is a generic name for a feature intended to be generic: moving the system pointer around.  There are certainly other options for it - like mousekeys - but this aims to be easily modifiable and lightweight.  You can implement custom keys to control functionality, or you can gather information from other peripherals and insert it directly here - let QMK handle the processing for you.

 To enable Pointing Device, uncomment the following line in your rules.mk:
--- a/docs/feature_ps2_mouse.md
+++ b/docs/feature_ps2_mouse.md
@ -1,5 +1,7 @@
 ## PS/2 Mouse Support

+[[toc]]
+
 Its possible to hook up a PS/2 mouse (for example touchpads or trackpoints) to your keyboard as a composite device.

 To hook up a Trackpoint, you need to obtain a Trackpoint module (i.e. harvest from a Thinkpad keyboard), identify the function of each pin of the module, and make the necessary circuitry between controller and Trackpoint module. For more information, please refer to [Trackpoint Hardware](https://deskthority.net/wiki/TrackPoint_Hardware) page on Deskthority Wiki.
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@ -1,5 +1,7 @@
 # RGB Matrix Lighting

+[[toc]]
+
 This feature allows you to use RGB LED matrices driven by external drivers. It hooks into the RGBLIGHT system so you can use the same keycodes as RGBLIGHT to control it.

 If you want to use single color LED's you should use the [LED Matrix Subsystem](feature_led_matrix.md) instead.
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@ -1,5 +1,7 @@
 # RGB Lighting

+[[toc]]
+
 QMK has the ability to control RGB LEDs attached to your keyboard. This is commonly called *underglow*, due to the LEDs often being mounted on the bottom of the keyboard, producing a nice diffused effect when combined with a translucent case.

 ![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/3774a7fcdab5544fc787f4c200be05fcd417e31f/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
--- a/docs/feature_space_cadet.md
+++ b/docs/feature_space_cadet.md
@ -1,5 +1,7 @@
 # Space Cadet: The Future, Built In

+[[toc]]
+
 Steve Losh described the [Space Cadet Shift](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/) quite well. Essentially, when you tap Left Shift on its own, you get an opening parenthesis; tap Right Shift on its own and you get the closing one. When held, the Shift keys function as normal. Yes, it's as cool as it sounds, and now even cooler supporting Control and Alt as well!

 ## Usage
--- a/docs/feature_split_keyboard.md
+++ b/docs/feature_split_keyboard.md
@ -1,5 +1,7 @@
 # Split Keyboard 

+[[toc]]
+
 Many keyboards in the QMK Firmware repo are "split" keyboards. They use two controllers—one plugging into USB, and the second connected by a serial or an I<sup>2</sup>C connection over a TRRS or similar cable. 

 Split keyboards can have a lot of benefits, but there is some additional work needed to get them enabled.  
--- a/docs/feature_stenography.md
+++ b/docs/feature_stenography.md
@ -1,5 +1,7 @@
 # Stenography in QMK

+[[toc]]
+
 [Stenography](https://en.wikipedia.org/wiki/Stenotype) is a method of writing most often used by court reports, closed-captioning, and real-time transcription for the deaf. In stenography words are chorded syllable by syllable with a mixture of spelling, phonetic, and shortcut (briefs) strokes. Professional stenographers can reach 200-300 WPM without any of the strain usually found in standard typing and with far fewer errors (>99.9% accuracy).

 The [Open Steno Project](http://www.openstenoproject.org/) has built an open-source program called Plover that provides real-time translation of steno strokes into words and commands. It has an established dictionary and supports
--- a/docs/feature_swap_hands.md
+++ b/docs/feature_swap_hands.md
@ -1,5 +1,7 @@
 # Swap-Hands Action

+[[toc]]
+
 The swap-hands action allows support for one-handed typing without requiring a separate layer. Set `SWAP_HANDS_ENABLE` in the Makefile and define a `hand_swap_config` entry in your keymap. Now whenever the `ACTION_SWAP_HANDS` command key is pressed the keyboard is mirrored. For instance, to type "Hello, World" on QWERTY you would type `^Ge^s^s^w^c W^wr^sd`

 ## Configuration
--- a/docs/feature_tap_dance.md
+++ b/docs/feature_tap_dance.md
@ -1,5 +1,7 @@
 # Tap Dance: A Single Key Can Do 3, 5, or 100 Different Things

+[[toc]]
+
 <!-- FIXME: Break this up into multiple sections -->

 Hit the semicolon key once, send a semicolon. Hit it twice, rapidly -- send a colon. Hit it three times, and your keyboard's LEDs do a wild dance. That's just one example of what Tap Dance can do. It's one of the nicest community-contributed features in the firmware, conceived and created by [algernon](https://github.com/algernon) in [#451](https://github.com/qmk/qmk_firmware/pull/451). Here's how algernon describes the feature:
--- a/docs/feature_terminal.md
+++ b/docs/feature_terminal.md
@ -1,5 +1,7 @@
 # Terminal

+[[toc]]
+
 > This feature is currently *huge* at 4400 bytes, and should probably only be put on boards with a lot of memory, or for fun.

 The terminal feature is a command-line-like interface designed to communicate through a text editor with keystrokes. It's beneficial to turn off auto-indent features in your editor.
--- a/docs/feature_thermal_printer.md
+++ b/docs/feature_thermal_printer.md
@ -1,5 +1,7 @@
 # Thermal Printer

+[[toc]]
+
 <!-- FIXME: Describe thermal printers support here. -->

 ## Thermal Printer Keycodes
--- a/docs/feature_unicode.md
+++ b/docs/feature_unicode.md
@ -1,5 +1,7 @@
 # Unicode Support

+[[toc]]
+
 Unicode characters can be input straight from your keyboard! There are some limitations, however.

 QMK has three different methods for enabling Unicode input and defining keycodes:
--- a/docs/feature_userspace.md
+++ b/docs/feature_userspace.md
@ -1,5 +1,7 @@
 # Userspace: Sharing Code Between Keymaps

+[[toc]]
+
 If you use more than one keyboard with a similar keymap, you might see the benefit in being able to share code between them. Create your own folder in `users/` named the same as your keymap (ideally your github username, `<name>`) with the following structure:

 * `/users/<name>/` (added to the path automatically)
--- a/docs/feature_velocikey.md
+++ b/docs/feature_velocikey.md
@ -1,5 +1,7 @@
 # Velocikey

+[[toc]]
+
 Velocikey is a feature that lets you control the speed of lighting effects (like the Rainbow Swirl effect) with the speed of your typing. The faster you type, the faster the lights will go!

 ## Usage
--- a/docs/features.md
+++ b/docs/features.md
@ -1,5 +1,7 @@
 # QMK Features

+[[toc]]
+
 QMK has a staggering number of features for building your keyboard. It can take some time to understand all of them and determine which one will achieve your goal.


--- a/docs/flashing.md
+++ b/docs/flashing.md
@ -1,5 +1,7 @@
 # Flashing Instructions and Bootloader Information

+[[toc]]
+
 There are quite a few different types of bootloaders that keyboards use, and just about all of the use a different flashing method. Luckily, projects like the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) aim to be compatible with all the different types without having to think about it much, but this article will describe the different types of bootloaders, and available methods for flashing them.

 If you have a bootloader selected with the `BOOTLOADER` variable in your `rules.mk`, QMK will automatically calculate if your .hex file is the right size to be flashed to the device, and output the total size in bytes (along with the max). To run this process manually, compile with the target `check-size`, eg `make planck/rev4:default:check-size`.
--- a/docs/getting_started_build_tools.md
+++ b/docs/getting_started_build_tools.md
@ -1,5 +1,7 @@
 # Installing Build Tools

+[[toc]]
+
 This page describes setting up the build environment for QMK. These instructions cover AVR processors (such as the atmega32u4).

 <!-- FIXME: We should have ARM instructions somewhere. -->
--- a/docs/getting_started_getting_help.md
+++ b/docs/getting_started_getting_help.md
@ -1,5 +1,7 @@
 # Getting Help

+[[toc]]
+
 There are a lot of resources for getting help with QMK.

 ## Realtime Chat
--- a/docs/getting_started_github.md
+++ b/docs/getting_started_github.md
@ -1,5 +1,7 @@
 # How to Use Github with QMK

+[[toc]]
+
 Github can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK.

 ?> This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system.
--- a/docs/getting_started_introduction.md
+++ b/docs/getting_started_introduction.md
@ -1,5 +1,7 @@
 # Introduction

+[[toc]]
+
 This page attempts to explain the basic information you need to know to work with the QMK project. It assumes that you are familiar with navigating a Unix shell, but does not assume you are familiar with C or with compiling using make.

 ## Basic QMK Structure
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@ -1,5 +1,7 @@
 # More Detailed `make` Instructions

+[[toc]]
+
 The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where:

 * `<keyboard_folder>` is the path of the keyboard, for example `planck`
--- a/docs/getting_started_vagrant.md
+++ b/docs/getting_started_vagrant.md
@ -1,5 +1,7 @@
 # Vagrant Quick Start

+[[toc]]
+
 This project includes a `Vagrantfile` that will allow you to build a new firmware for your keyboard very easily without major changes to your primary operating system. This also ensures that when you clone the project and perform a build, you have the exact same environment as anyone else using the Vagrantfile to build. This makes it much easier for people to help you troubleshoot any issues you encounter.

 ## Requirements
@ -54,4 +56,4 @@ Execute the following to bypass the `vagrant` user booting directly to the offic

 ```console
 vagrant ssh -c 'sudo -i'
-```
+```
--- a/docs/hand_wire.md
+++ b/docs/hand_wire.md
@ -1,5 +1,7 @@
 # Quantum Hand-Wiring Guide

+[[toc]]
+
 Parts list:
 * *x* keyswitches (MX, Matias, Gateron, etc)
 * *x* diodes
--- a/docs/hardware.md
+++ b/docs/hardware.md
@ -1,5 +1,7 @@
 # Hardware

+[[toc]]
+
 QMK runs on a variety of hardware. If your processor can be targeted by [LUFA](http://www.fourwalledcubicle.com/LUFA.php) or [ChibiOS](http://www.chibios.com) you can probably get QMK running on it. This section explores getting QMK running on, and communicating with, hardware of all kinds.

 * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
--- a/docs/hardware_avr.md
+++ b/docs/hardware_avr.md
@ -1,5 +1,7 @@
 # Keyboards with AVR Processors

+[[toc]]
+
 This page describes the support for for AVR processors in QMK. AVR processors include the atmega32u4, atmega32u2, at90usb1286, and other processors from Atmel Corporation. AVR processors are 8-bit MCU's that are designed to be easy to work with. The most common AVR processors in keyboards have on-board USB and plenty of GPIO for supporting large keyboard matrices. They are the most popular MCU for use in keyboards today.

 If you have not yet you should read the [Keyboard Guidelines](hardware_keyboard_guidelines.md) to get a sense of how keyboards fit into QMK.
--- a/docs/hardware_drivers.md
+++ b/docs/hardware_drivers.md
@ -1,5 +1,7 @@
 # QMK Hardware Drivers

+[[toc]]
+
 QMK is used on a lot of different hardware. While support for the most common MCU's and matrix configurations is built-in there are a number of drivers that can be added to a keyboard to support additional hardware. Examples include mice and other pointing devices, i/o expanders for split keyboards, bluetooth modules, and LCD, OLED, and TFT screens.

 <!-- FIXME: This should talk about how drivers are integrated into QMK and how you can add your own driver.
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@ -1,5 +1,7 @@
 # QMK Keyboard Guidelines

+[[toc]]
+
 Since starting, QMK has grown by leaps and bounds thanks to people like you who contribute to creating and maintaining our community keyboards. As we've grown we've discovered some patterns that work well, and ask that you conform to them to make it easier for other people to benefit from your hard work.


--- a/docs/how_keyboards_work.md
+++ b/docs/how_keyboards_work.md
@ -1,5 +1,7 @@
 # How Keys Are Registered, and Interpreted by Computers

+[[toc]]
+
 In this file, you can will learn the concepts of how keyboards work over USB,
 and you'll be able to better understand what you can expect from changing your
 firmware directly.
--- a/docs/i2c_driver.md
+++ b/docs/i2c_driver.md
@ -1,5 +1,7 @@
 # I2C Master Driver

+[[toc]]
+
 The I2C Master drivers used in QMK have a set of common functions to allow portability between MCUs.

 ## Available functions
--- a/docs/internals_defines.md
+++ b/docs/internals_defines.md
@ -1,5 +1,7 @@
 # group `defines` {#group__defines}

+[[toc]]
+
 ## Summary

 Members                        | Descriptions                                
--- a/docs/internals_gpio_control.md
+++ b/docs/internals_gpio_control.md
@ -1,5 +1,7 @@
 # GPIO Control

+[[toc]]
+
 QMK has a GPIO control abstraction layer which is microcontroller agnostic. This is done to allow easy access to pin control across different platforms.

 ## Functions
--- a/docs/internals_input_callback_reg.md
+++ b/docs/internals_input_callback_reg.md
@ -1,5 +1,7 @@
 # group `input_callback_reg` {#group__input__callback__reg}

+[[toc]]
+
 These are the functions you use to register your input callbacks.

 The functions are called when the appropriate midi message is matched on the associated device's input.
--- a/docs/internals_midi_device.md
+++ b/docs/internals_midi_device.md
@ -1,5 +1,7 @@
 # group `midi_device` {#group__midi__device}

+[[toc]]
+
 You use the functions when you are implementing your own midi device.

 You set a send function to actually send bytes via your device, this method is called when you call a send function with this device, for instance midi_send_cc
--- a/docs/internals_midi_device_setup_process.md
+++ b/docs/internals_midi_device_setup_process.md
@ -1,5 +1,7 @@
 # group `midi_device_setup_process` {#group__midi__device__setup__process}

+[[toc]]
+
 These are method that you must use to initialize and run a device.

 ## Summary
--- a/docs/internals_midi_util.md
+++ b/docs/internals_midi_util.md
@ -1,5 +1,7 @@
 # group `midi_util` {#group__midi__util}

+[[toc]]
+
 ## Summary

 Members                        | Descriptions                                
--- a/docs/isp_flashing_guide.md
+++ b/docs/isp_flashing_guide.md
@ -1,5 +1,7 @@
 # ISP Flashing Guide

+[[toc]]
+
 If you're having trouble flashing/erasing your board, and running into cryptic error messages like any of the following:

    libusb: warning [darwin_transfer_status] transfer error: timed out
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@ -1,5 +1,7 @@
 # Keycodes Overview

+[[toc]]
+
 When defining a [keymap](keymap.md) each key needs a valid key definition. This page documents the symbols that correspond to keycodes that are available to you in QMK.

 This is a reference only. Each group of keys links to the page documenting their functionality in more detail.
--- a/docs/keycodes_basic.md
+++ b/docs/keycodes_basic.md
@ -1,5 +1,7 @@
 # Basic Keycodes

+[[toc]]
+
 The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07)](https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf) with the exception of `KC_NO`, `KC_TRNS` and keycodes in the `0xA5-DF` range. See below for more details.

 ## Letters and Numbers
--- a/docs/keycodes_us_ansi_shifted.md
+++ b/docs/keycodes_us_ansi_shifted.md
@ -1,5 +1,7 @@
 # US ANSI Shifted Symbols

+[[toc]]
+
 These keycodes correspond to characters that are "shifted" on a standard US ANSI keyboard. They do not have keycodes of their own but are simply shortcuts for `LSFT(kc)`, and as such send a Left Shift with the unshifted keycode, not the symbol itself.

 ## Caveats
--- a/docs/keymap.md
+++ b/docs/keymap.md
@ -1,5 +1,7 @@
 # Keymap Overview

+[[toc]]
+
 QMK keymaps are defined inside a C source file. The data structure is an array of arrays. The outer array is a list of layer arrays while the inner layer array is a list of keys. Most keyboards define a `LAYOUT()` macro to help you create this array of arrays.


--- a/docs/makers_modders.md
+++ b/docs/makers_modders.md
@ -0,0 +1,3 @@
+# For Makers and Modders
+
+* TBD
--- a/docs/newbs.md
+++ b/docs/newbs.md
@ -1,5 +1,7 @@
 # The Complete Newbs Guide To QMK

+[[toc]]
+
 QMK is a powerful Open Source firmware for your mechanical keyboard. You can use QMK to customize your keyboard in ways both simple and powerful. People of all skill levels, from complete newbie to master programmer, have successfully used QMK to customize their keyboard. This guide will help you do the same, no matter your skill level.

 Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](http://qmk.fm/keyboards/), so even if your current keyboard can't run QMK you shouldn't have trouble finding one to suit your needs.
--- a/docs/newbs_best_practices.md
+++ b/docs/newbs_best_practices.md
@ -1,5 +1,7 @@
 # Best Practices

+[[toc]]
+
 ## Or, "How I Learned to Stop Worrying and Love Git."

 This document aims to instruct novices in the best ways to have a smooth experience in contributing to QMK. We will walk through the process of contributing to QMK, detailing some ways to make this task easier, and then later we'll break some things in order to teach you how to fix them.
--- a/docs/newbs_building_firmware.md
+++ b/docs/newbs_building_firmware.md
@ -1,5 +1,7 @@
 # Building Your First Firmware

+[[toc]]
+
 Now that you have setup your build environment you are ready to start building custom firmware. For this section of the guide we will bounce between 3 programs- your file manager, your text editor, and your terminal window. Keep all 3 open until you are done and happy with your keyboard firmware.

 If you have closed and reopened your terminal window since following the first part of the guide, don't forget to `cd qmk_firmware` so that your terminal is in the correct directory.
--- a/docs/newbs_building_firmware_configurator.md
+++ b/docs/newbs_building_firmware_configurator.md
@ -1,5 +1,7 @@
 # QMK Configurator

+[[toc]]
+
 The [QMK Configurator](https://config.qmk.fm) is an online graphical user interface that generates QMK Firmware hex files.  

 ?> **Please follow these steps in order.**
--- a/docs/newbs_flashing.md
+++ b/docs/newbs_flashing.md
@ -1,5 +1,7 @@
 # Flashing Your Keyboard 

+[[toc]]
+
 Now that you've built a custom firmware file you'll want to flash your keyboard. 

 ## Flashing Your Keyboard with QMK Toolbox
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@ -1,5 +1,7 @@
 # Introduction

+[[toc]]
+
 Your computer keyboard has a processor inside of it, not unlike the one inside your computer. This processor runs software that is responsible for detecting button presses and sending reports about the state of the keyboard when buttons are pressed or released. QMK fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating the equivalent of an executable program for your keyboard.

 QMK tries to put a lot of power into your hands by making easy things easy, and hard things possible. You don't have to know how to program to create powerful keymaps — you only have to follow a few simple syntax rules.
--- a/docs/newbs_learn_more_resources.md
+++ b/docs/newbs_learn_more_resources.md
@ -1,5 +1,7 @@
 # Learning Resources

+[[toc]]
+
 These resources are aimed at giving new members in the QMK community more understanding to the information provided in the Newbs docs.

 Git resources:
--- a/docs/newbs_testing_debugging.md
+++ b/docs/newbs_testing_debugging.md
@ -1,5 +1,7 @@
 # Testing and Debugging

+[[toc]]
+
 Once you've flashed your keyboard with a custom firmware you're ready to test it out. With a little bit of luck everything will work perfectly, but if not this document will help you figure out what's wrong.

 ## Testing
--- a/docs/other_eclipse.md
+++ b/docs/other_eclipse.md
@ -1,5 +1,7 @@
 # Setting up Eclipse for QMK Development

+[[toc]]
+
 [Eclipse][1] is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages.

 Using an IDE such as Eclipse provides many advantages over a plain text editor, such as:
@ -85,4 +87,4 @@ We will now configure a make target that cleans the project and builds the keyma
 8. Double-click the build target you created to trigger a build.
 9. Select the <kbd>Console</kbd> view at the bottom to view the running build.

-  [1]: https://en.wikipedia.org/wiki/Eclipse_(software)
+  [1]: https://en.wikipedia.org/wiki/Eclipse_(software)
--- a/docs/other_topics.md
+++ b/docs/other_topics.md
@ -0,0 +1 @@
+# Other Topics
--- a/docs/other_vscode.md
+++ b/docs/other_vscode.md
@ -1,5 +1,7 @@
 # Setting up Visual Studio Code for QMK Development

+[[toc]]
+
 [Visual Studio Code](https://code.visualstudio.com/) (VS Code) is an open-source code editor that supports many different programming languages. 

 Using a full-featured editor such as VS Code provides many advantages over a plain text editor, such as:
--- a/docs/proton_c_conversion.md
+++ b/docs/proton_c_conversion.md
@ -1,5 +1,7 @@
 # Converting a board to use the Proton C

+[[toc]]
+
 If a board currently supported in QMK uses a Pro Micro (or compatible board) and you want to use the Proton C, you can generate the firmware by appending `CONVERT_TO_PROTON_C=yes` (or `CTPC=yes`) to your make argument, like this:

    make 40percentclub/mf68:default CTPC=yes
--- a/docs/python_development.md
+++ b/docs/python_development.md
@ -1,5 +1,7 @@
 # Python Development in QMK

+[[toc]]
+
 This document gives an overview of how QMK has structured its python code. You should read this before working on any of the python code.

 ## Script directories
--- a/docs/qmk_internals.md
+++ b/docs/qmk_internals.md
@ -0,0 +1 @@
+# QMK Internals
--- a/docs/quantum_keycodes.md
+++ b/docs/quantum_keycodes.md
@ -1,5 +1,7 @@
 # Quantum Keycodes

+[[toc]]
+
 Quantum keycodes allow for easier customization of your keymap than the basic ones provide, without having to define custom actions.

 All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within your `keymap.c` it may look like you have functions and other special cases, but ultimately the C preprocessor will translate those into a single 4 byte integer. QMK has reserved `0x0000` through `0x00FF` for standard keycodes. These are keycodes such as `KC_A`, `KC_1`, and `KC_LCTL`, which are basic keys defined in the USB HID specification.
--- a/docs/ref_functions.md
+++ b/docs/ref_functions.md
@ -1,5 +1,7 @@
 # List of Useful Core Functions To Make Your Keyboard Better

+[[toc]]
+
 There are a lot of hidden functions in QMK that are incredible useful, or may add a bit of functionality that you've been wanting.  Functions that are specific to certain features are not included here, as those will be on their respective feature page.

 ## (OLKB) Tri Layers
--- a/docs/reference.md
+++ b/docs/reference.md
@ -0,0 +1 @@
+# Reference
--- a/docs/reference_configurator_support.md
+++ b/docs/reference_configurator_support.md
@ -1,5 +1,7 @@
 # Supporting Your Keyboard in QMK Configurator

+[[toc]]
+
 This page covers how to properly support keyboards in the [QMK Configurator](https://config.qmk.fm/).


--- a/docs/reference_glossary.md
+++ b/docs/reference_glossary.md
@ -1,5 +1,7 @@
 # Glossary of QMK Terms

+[[toc]]
+
 ## ARM
 A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI.

--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@ -1,5 +1,7 @@
 # `info.json`

+[[toc]]
+
 This file is used by the [QMK API](https://github.com/qmk/qmk_api). It contains the information [QMK Configurator](https://config.qmk.fm/) needs to display a representation of your keyboard. You can also set metadata here.

 You can create `info.json` files at every level under `qmk_firmware/keyboards/<name>` to specify this metadata. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` specifies more specific information about Clueboard 66%.
--- a/docs/support.md
+++ b/docs/support.md
@ -1,5 +1,7 @@
 # Support

+[[toc]]
+
 If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/Uq7gcHh).  There is usually somebody online, and there are a bunch of very helpful people there.

 Don't forget to read our [Code of Conduct](https://qmk.fm/coc/).
--- a/docs/understanding_qmk.md
+++ b/docs/understanding_qmk.md
@ -1,5 +1,7 @@
 # Understanding QMK's Code

+[[toc]]
+
 This document attempts to explain how the QMK firmware works from a very high level. It assumes you understand basic programming concepts but does not (except where needed to demonstrate) assume familiarity with C. It assumes that you have a basic understanding of the following documents:

 * [Introduction](getting_started_introduction.md)
--- a/docs/unit_testing.md
+++ b/docs/unit_testing.md
@ -1,5 +1,7 @@
 # Unit Testing

+[[toc]]
+
 If you are new to unit testing, then you can find many good resources on internet. However most of it is scattered around in small pieces here and there, and there's also many different opinions, so I won't give any recommendations.

 Instead I recommend these two books, explaining two different styles of Unit Testing in detail.
--- a/package.json
+++ b/package.json
@ -0,0 +1,6 @@
+{
+  "scripts": {
+    "docs:dev": "vuepress dev docs",
+    "docs:build": "vuepress build docs"
+  }
+}
--- a/util/travis_docs.sh
+++ b/util/travis_docs.sh
@ -11,4 +11,25 @@ if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip docs]"* ]] ; then
 		git add docs/internals_*
 		git commit -m'autogenerated internal docs for ${TRAVIS_COMMIT_RANGE}' || true
 	fi
+
+	# make sure vuepress is installed
+	if ! vuepress 2>&1 > /dev/null; then
+		if ! npm 2>&1 > /dev/null; then
+			echo ABORT! We need npm installed!
+			exit 1
+		fi
+		npm install -g vuepress
+	fi
+
+	# build
+	npm run docs:build
+
+	# Publish the docs
+	#cd docs/.vuepress/dist
+	#echo 'docs.qmk.fm' > CNAME
+	#git init
+	#git add -A
+	#git commit -m 'docs gh-pages deploy'
+	#git push -f git@github.com:<USERNAME>/<REPO>.git master:gh-pages
+	#cd -
 fi