index.html 5.6 KB

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