index.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>QMK Firmware</title>
  6. <link rel="icon" type="image/png" href="gitbook/images/favicon.png">
  7. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  8. <meta name="description" content="Description">
  9. <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  10. <meta property="og:title" content="QMK Firmware Docs">
  11. <meta property="og:type" content="website">
  12. <meta property="og:description" content="The full documentation of the open-source firmware">
  13. <meta property="og:image" content="https://i.imgur.com/svjvIrw.jpg">
  14. <meta property="og:url" content="https://docs.qmk.fm">
  15. <meta name="twitter:card" content="summary_large_image">
  16. <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css" title="light">
  17. <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css" media="(prefers-color-scheme: dark)">
  18. <link rel="stylesheet" href="//unpkg.com/docsify-toc@1.0.0/dist/toc.css">
  19. <link rel="stylesheet" href="qmk_custom_light.css">
  20. <link rel="stylesheet" href="qmk_custom_dark.css" media="(prefers-color-scheme: dark)">
  21. </head>
  22. <body>
  23. <div id="app"></div>
  24. <script>
  25. window.$docsify = {
  26. alias: {
  27. // Translation aliases
  28. '/en/(.*)': '/$1',
  29. '/en-us/(.*)': '/$1',
  30. '/en-gb/(.*)': '/$1',
  31. '/.*/_langs.md': '/_langs.md',
  32. // Moved pages
  33. '/adding_a_keyboard_to_qmk': '/hardware_keyboard_guidelines',
  34. '/build_environment_setup': '/getting_started_build_tools',
  35. '/dynamic_macros': '/feature_dynamic_macros',
  36. '/feature_common_shortcuts': '/feature_advanced_keycodes',
  37. '/glossary': '/reference_glossary',
  38. '/key_lock': '/feature_key_lock',
  39. '/make_instructions': '/getting_started_make_guide',
  40. '/porting_your_keyboard_to_qmk': '/hardware_avr',
  41. '/space_cadet_shift': '/feature_space_cadet_shift',
  42. '/getting_started_getting_help': '/support',
  43. '/tap_dance': '/feature_tap_dance',
  44. '/unicode': '/feature_unicode',
  45. '/python_development': '/cli_development',
  46. },
  47. basePath: '/',
  48. name: 'QMK Firmware',
  49. nameLink: {
  50. '/de/': '/#/de/',
  51. '/es/': '/#/es/',
  52. '/fr-fr/': '/#/fr-fr/',
  53. '/he-il/': '/#/he-il/',
  54. '/ja/': '/#/ja/',
  55. '/pt-br/': '/#/pt-br/',
  56. '/ru-ru/': '/#/ru-ru/',
  57. '/zh-cn/': '/#/zh-cn/',
  58. '/': '/#/'
  59. },
  60. repo: 'qmk/qmk_firmware',
  61. loadSidebar: '_summary.md',
  62. loadNavbar: '_langs.md',
  63. mergeNavbar: true,
  64. auto2top: true,
  65. autoHeader: true,
  66. fallbackLanguages: [
  67. 'de',
  68. 'es',
  69. 'fr-fr',
  70. 'he-il',
  71. 'ja',
  72. 'pt-br',
  73. 'ru-ru',
  74. 'zh-cn'
  75. ],
  76. formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}',
  77. search: {
  78. paths: 'auto',
  79. placeholder: {
  80. '/es/': 'Buscar',
  81. '/zh-cn/': '搜索',
  82. '/ja/': '検索',
  83. '/pt-br/': 'Busca',
  84. '/': 'Search'
  85. },
  86. noData: {
  87. '/es/': '¡Ningún resultado!',
  88. '/zh-cn/': '没有结果!',
  89. '/ja/': '見つかりません!',
  90. '/pt-br/': 'Nenhum resultado!',
  91. '/': 'No results!'
  92. },
  93. depth: 6
  94. },
  95. markdown: {
  96. smartypants: true,
  97. smartLists: true,
  98. },
  99. copyCode: {
  100. buttonText: {
  101. '/zh-cn/': '点击复制',
  102. '/ru/' : 'Скопировать в буфер обмена',
  103. '/de-de/': 'Klicken Sie zum Kopieren',
  104. '/es/' : 'Haga clic para copiar',
  105. '/' : 'Copy to clipboard'
  106. },
  107. errorText: {
  108. '/zh-cn/': '错误',
  109. '/ru/' : 'ошибка',
  110. '/' : 'Error'
  111. },
  112. successText: {
  113. '/zh-cn/': '复制',
  114. '/ru/' : 'Скопировано',
  115. '/de-de/': 'Kopiert',
  116. '/es/' : 'Copiado',
  117. '/' : 'Copied'
  118. }
  119. },
  120. toc: {
  121. scope: '.markdown-section',
  122. headings: 'h1, h2',
  123. title: 'Table of Contents',
  124. },
  125. plugins: [
  126. function (hook, vm) {
  127. hook.beforeEach(function (html) {
  128. if (/githubusercontent\.com/.test(vm.route.file)) {
  129. url = vm.route.file
  130. .replace('raw.githubusercontent.com', 'github.com')
  131. .replace(/\/master/, '/blob/master')
  132. } else {
  133. url = 'https://github.com/qmk/qmk_firmware/edit/master/docs/' + vm.route.file
  134. }
  135. var editHtml = ':pencil2: [Edit this page](' + url + ')\n'
  136. return html
  137. + '\n\n----\n\n'
  138. + editHtml
  139. })
  140. },
  141. ]
  142. }
  143. </script>
  144. <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
  145. <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
  146. <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
  147. <script src="//unpkg.com/docsify-copy-code@2"></script>
  148. <script src="//unpkg.com/docsify-toc@1.0.0/dist/toc.js"></script>
  149. <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
  150. <script src="//unpkg.com/prismjs/components/prism-c.min.js"></script>
  151. <script src="//unpkg.com/prismjs/components/prism-cpp.min.js"></script>
  152. <script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
  153. <script src="//unpkg.com/prismjs/components/prism-makefile.min.js"></script>
  154. <script>
  155. // Register the cache worker for offline viewing mode
  156. // https://docsify.now.sh/pwa
  157. if (typeof navigator.serviceWorker !== 'undefined') {
  158. navigator.serviceWorker.register('sw.js')
  159. }
  160. </script>
  161. </body>
  162. </html>