From bb8c5cd54aa4a3b16a90f917da8637fce12ec1aa Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Tue, 18 Apr 2023 13:44:25 -0400 Subject: [PATCH] half of summary added --- docs/docusaurus.config.js | 27 +-- docs/gitbook/images/favicon.ico | Bin 1150 -> 0 bytes docs/gitbook/images/favicon.png | Bin 793 -> 0 bytes docs/newbs.md | 3 +- docs/sidebars.js | 223 ++++++++++++++++-- docs/src/components/HomepageFeatures/index.js | 64 ----- .../HomepageFeatures/styles.module.css | 11 - docs/src/pages/index.js | 41 ---- docs/src/pages/markdown-page.md | 7 - docs/static/img/favicon.ico | Bin 3626 -> 1150 bytes docs/test/README.md | 41 ---- 11 files changed, 222 insertions(+), 195 deletions(-) delete mode 100644 docs/gitbook/images/favicon.ico delete mode 100644 docs/gitbook/images/favicon.png delete mode 100644 docs/src/components/HomepageFeatures/index.js delete mode 100644 docs/src/components/HomepageFeatures/styles.module.css delete mode 100644 docs/src/pages/index.js delete mode 100644 docs/src/pages/markdown-page.md delete mode 100644 docs/test/README.md diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 1f81dc0adf0..8cf0e9f4f47 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -6,7 +6,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'My Site', + title: 'QMK', tagline: 'Dinosaurs are cool', favicon: 'img/favicon.ico', @@ -53,14 +53,14 @@ const config = { // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + 'https://github.com/qmk/qmk_firmware/edit/master/docs/', }, // blog: { // showReadingTime: true, // // Please change this to your repo. // // Remove this to remove the "edit this page" links. // editUrl: - // 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + // 'https://github.com/qmk/qmk_firmware/edit/master/docs/', // }, theme: { customCss: require.resolve('./src/css/custom.css'), @@ -75,21 +75,20 @@ const config = { // Replace with your project's social card image: 'img/docusaurus-social-card.jpg', navbar: { - title: 'My Site', + title: 'QMK Firmware Docs', logo: { alt: 'My Site Logo', src: 'img/logo.svg', }, - items: [ + items: [ + // { + // type: 'docSidebar', + // sidebarId: 'summary', + // position: 'left', + // label: 'Summary', + // }, { - type: 'docSidebar', - sidebarId: 'tutorialSidebar', - position: 'left', - label: 'Tutorial', - }, - {to: '/blog', label: 'Blog', position: 'left'}, - { - href: 'https://github.com/facebook/docusaurus', + href: 'https://github.com/qmk/qmk_firmware', label: 'GitHub', position: 'right', }, @@ -138,7 +137,7 @@ const config = { ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} QMK, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} QMK. Built with Docusaurus.`, }, prism: { theme: lightCodeTheme, diff --git a/docs/gitbook/images/favicon.ico b/docs/gitbook/images/favicon.ico deleted file mode 100644 index 2b4e04abafb33adc0bdf4c8da56de2dd73cce097..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1150 zcmb_cy>5d*40hCPSt3>H+_5_oVnOM^8}I@wS=kw~u`uu?z)P@4VnqVh?)*x~wGSOi z$k7m~Am4Y`{`~ol1Araf$0N}A3Fke)2LODLk&8T&p8$Yj?}y36^FI$k5FnR)hD%vZ z(@tbpGTdOCce<_d0$0|*N!{+EWg%aTs`#3|<2YDV7505E z_+8gwp66)W_FWy7zG<2`3n`7)6oL;P;-U>AYv`=lF{L w*0U@5^ZDaGsOC4>)*27z|8^}rmwU5@GM^FYi~WfKE^m|3Pejb0A?Gvi7u3j=jsO4v diff --git a/docs/gitbook/images/favicon.png b/docs/gitbook/images/favicon.png deleted file mode 100644 index 509cebd8798b54b3b203cd3e45b0346dd795347d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 793 zcmV+!1LpjRP)g8{I#3Okck9IIj_rDcTW z<+w8Gg7SMG^Ck9pb}l5bN4yK2AQSj;GQ}7Hd<-%ovkwnm`ej9p{DGhRS#pxA$gEOC zV}&Fs^0-AUNcFhHgy?Y@X^Lk5|Mpc+40+4d?S5!@GK{xgXxxI*reS;@8b;{|tdDS! zt>otpVEA41&5GvQ2gf>`T~@T%4xDd5=Yty6qCb*V+>%JZ>j|_(pzRu(7Rx>R-RJlo z!fWzXSFpPWeRAHh^bIL>XUb$&=#&5e010qNS#tmY3ljhU3ljkVnw%H_00BKoL_t(I zjir-6Zo)7Whrf78GGyc)RPqK=5~%~Z1v4vRi@5>qz-gFz14~89kc}LGjYuGb^g1-= zPm`il{VkTC-_QR1{0w(mtya=!yq5={wSEQOfZ@-C4sC(Cwe|x*HNn1Sn!I;6Q4Q7* zAdX}5JO>~QL)PmxVHg6C=Q(j4UpH~rQH#aGbI~M8$g&K8D2f=3Mnq8rz+^HZNs=pu z^Qo@F^ie0lGkKne$nC67f~u+rf&kz5AI!e*69fTeS+)oO&{~VuTGBL?^Z6{h-A;@# zA|hgpk*ccXcs$B@JQkPhyblD2!-3gshEj^ If the thought of programming intimidates you, please [take a look at our online GUI](newbs_building_firmware_configurator.md) instead. ::: diff --git a/docs/sidebars.js b/docs/sidebars.js index 9ab54c2459c..b1fa01821a5 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -13,21 +13,214 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], - */ + // By default, Docusaurus generates a sidebar from the docs folder structure + summary: [ + { + type: "doc", + id: "README", + label: "About QMK", + }, + { + type: "category", + label: "Tutorial", + link: { + type: "doc", + id: "newbs", + }, + items: [ + // "newbs", + "newbs_getting_started", + "newbs_building_firmware", + "newbs_flashing", + "support", + "newbs_building_firmware_workflow", + "newbs_learn_more_resources", + "syllabus", + ], + }, + { + type: "category", + label: "FAQs", + link: { + type: "doc", + id: "faq_general", + }, + items: [ + // "faq_general", + "faq_build", + "faq_misc", + "faq_debug", + "faq_keymap", + "squeezing_avr", + "reference_glossary", + ], + }, + { + type: "category", + label: "Configurator", + link: { + type: "doc", + id: "newbs_building_firmware_configurator", + }, + items: [ + // "newbs_building_firmware_configurator", + "configurator_step_by_step", + "configurator_troubleshooting", + "configurator_architecture", + { + type: "category", + label: "QMK API", + link: { + type: "doc", + id: "api_overview", + }, + items: [ + // "api_overview", + "api_docs", + "reference_configurator_support", + "configurator_default_keymaps", + ], + }, + ], + }, + { + type: "category", + label: "CLI", + link: { + type: "doc", + id: "cli", + }, + items: [ + // "cli", + "cli_configuration", + "cli_commands", + "cli_tab_complete", + ], + }, + { + type: "category", + label: "Using QMK", + items: [ + { + Guides: [ + "custom_quantum_functions", + "driver_installation_zadig", + "keymap", + { + "Development Environments": [ + "getting_started_docker", + "getting_started_vagrant", + ], + }, + { + Flashing: ["flashing", "flashing_bootloadhid"], + IDEs: ["other_eclipse", "other_vscode"], + "Git Best Practices": [ + "newbs_git_best_practices", + "newbs_git_using_your_master_branch", + "newbs_git_resolving_merge_conflicts", + "newbs_git_resynchronize_a_branch", + ], + }, + ], + }, + { + "Simple Keycodes": [ + "keycodes", + "keycodes_basic", + "reference_keymap_extras", + "feature_advanced_keycodes", + "quantum_keycodes", + "keycodes_magic", + ], + }, + { + "Advanced Keycodes": [ + "feature_command", + "feature_dynamic_macros", + "feature_grave_esc", + "feature_leader_key", + "mod_tap", + "feature_macros", + "feature_mouse_keys", + "feature_programmable_button", + "feature_space_cadet", + "keycodes_us_ansi_shifted", + ], + }, + { + "Software Features": [ + "feature_auto_shift", + "feature_autocorrect", + "feature_caps_word", + "feature_combo", + "feature_debounce_type", + "feature_eeprom", + "feature_key_lock", + "feature_key_overrides", + "feature_layers", + "one_shot_keys", + "feature_os_detection", + "feature_rawhid", + "feature_secure", + "feature_send_string", + "feature_sequencer", + "feature_swap_hands", + "feature_tap_dance", + "tap_hold", + "feature_tri_layer", + "feature_unicode", + "feature_userspace", + "feature_wpm", + ], + }, + { + "Hardware Features": [ + { + Displays: [ + "quantum_painter", + "quantum_painter_lvgl", + "feature_hd44780", + "feature_st7565", + "feature_oled_driver", + ], + Lighting: [ + "feature_backlight", + "feature_led_matrix", + "feature_rgblight", + "feature_rgb_matrix", + ], + }, + "feature_audio", + "feature_bluetooth", + "feature_bootmagic", + "feature_converters", + "custom_matrix", + "feature_digitizer", + "feature_dip_switch", + "feature_encoders", + "feature_haptic_feedback", + "feature_joystick", + "feature_led_indicators", + "feature_midi", + "feature_pointing_device", + "feature_ps2_mouse", + "feature_split_keyboard", + "feature_stenography", + "feature_velocikey", + ], + }, + { + "Keyboard Building": [ + "easy_maker", + "porting_your_keyboard_to_qmk", + "hand_wire", + "isp_flashing_guide", + ], + }, + ], + }, + ], }; module.exports = sidebars; diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js deleted file mode 100644 index 78f410ba688..00000000000 --- a/docs/src/components/HomepageFeatures/index.js +++ /dev/null @@ -1,64 +0,0 @@ -import React from 'react'; -import clsx from 'clsx'; -import styles from './styles.module.css'; - -const FeatureList = [ - { - title: 'Easy to Use', - Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, - description: ( - <> - Docusaurus was designed from the ground up to be easily installed and - used to get your website up and running quickly. - - ), - }, - { - title: 'Focus on What Matters', - Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, - description: ( - <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go - ahead and move your docs into the docs directory. - - ), - }, - { - title: 'Powered by React', - Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, - description: ( - <> - Extend or customize your website layout by reusing React. Docusaurus can - be extended while reusing the same header and footer. - - ), - }, -]; - -function Feature({Svg, title, description}) { - return ( -
-
- -
-
-

{title}

-

{description}

-
-
- ); -} - -export default function HomepageFeatures() { - return ( -
-
-
- {FeatureList.map((props, idx) => ( - - ))} -
-
-
- ); -} diff --git a/docs/src/components/HomepageFeatures/styles.module.css b/docs/src/components/HomepageFeatures/styles.module.css deleted file mode 100644 index b248eb2e5de..00000000000 --- a/docs/src/components/HomepageFeatures/styles.module.css +++ /dev/null @@ -1,11 +0,0 @@ -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js deleted file mode 100644 index affcd9099c2..00000000000 --- a/docs/src/pages/index.js +++ /dev/null @@ -1,41 +0,0 @@ -import React from 'react'; -import clsx from 'clsx'; -import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; - -import styles from './index.module.css'; - -function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); - return ( -
-
-

{siteConfig.title}

-

{siteConfig.tagline}

-
- - Docusaurus Tutorial - 5min ⏱️ - -
-
-
- ); -} - -export default function Home() { - const {siteConfig} = useDocusaurusContext(); - return ( - - -
- -
- - ); -} diff --git a/docs/src/pages/markdown-page.md b/docs/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b6685..00000000000 --- a/docs/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico index c01d54bcd39a5f853428f3cd5aa0f383d963c484..2b4e04abafb33adc0bdf4c8da56de2dd73cce097 100644 GIT binary patch literal 1150 zcmb_cy>5d*40hCPSt3>H+_5_oVnOM^8}I@wS=kw~u`uu?z)P@4VnqVh?)*x~wGSOi z$k7m~Am4Y`{`~ol1Araf$0N}A3Fke)2LODLk&8T&p8$Yj?}y36^FI$k5FnR)hD%vZ z(@tbpGTdOCce<_d0$0|*N!{+EWg%aTs`#3|<2YDV7505E z_+8gwp66)W_FWy7zG<2`3n`7)6oL;P;-U>AYv`=lF{L w*0U@5^ZDaGsOC4>)*27z|8^}rmwU5@GM^FYi~WfKE^m|3Pejb0A?Gvi7u3j=jsO4v literal 3626 zcmb`Je@s(X6vrR`EK3%b%orErlDW({vnABqA zcfaS{d+xbU5JKp0*;0YOg+;Fl!eT)XRuapIwFLL`=imZCSon$`se`_<%@MB=M~KG+ z=EW^FL`w|Bo>*ktlaS^(fut!95`iG5u=SZ8nfDHO#GaTlH1-XG^;vsjUb^gWTVz0+ z^=WR1wv9-2oeR=_;fL0H7rNWqAzGtO(D;`~cX(RcN0w2v24Y8)6t`cS^_ghs`_ho? z{0ka~1Dgo8TfAP$r*ua?>$_V+kZ!-(TvEJ7O2f;Y#tezt$&R4 zLI}=-y@Z!grf*h3>}DUL{km4R>ya_I5Ag#{h_&?+HpKS!;$x3LC#CqUQ8&nM?X))Q zXAy2?`YL4FbC5CgJu(M&Q|>1st8XXLZ|5MgwgjP$m_2Vt0(J z&Gu7bOlkbGzGm2sh?X`){7w69Y$1#@P@7DF{ZE=4%T0NDS)iH`tiPSKpDNW)zmtn( zw;4$f>k)4$LBc>eBAaTZeCM2(iD+sHlj!qd z2GjRJ>f_Qes(+mnzdA^NH?^NB(^o-%Gmg$c8MNMq&`vm@9Ut;*&$xSD)PKH{wBCEC z4P9%NQ;n2s59ffMn8*5)5AAg4-93gBXBDX`A7S& zH-|%S3Wd%T79fk-e&l`{!?lve8_epXhE{d3Hn$Cg!t=-4D(t$cK~7f&4s?t7wr3ZP z*!SRQ-+tr|e1|hbc__J`k3S!rMy<0PHy&R`v#aJv?`Y?2{avK5sQz%=Us()jcNuZV z*$>auD4cEw>;t`+m>h?f?%VFJZj8D|Y1e_SjxG%J4{-AkFtT2+ZZS5UScS~%;dp!V>)7zi`w(xwSd*FS;Lml=f6hn#jq)2is4nkp+aTrV?)F6N z>DY#SU0IZ;*?Hu%tSj4edd~kYNHMFvS&5}#3-M;mBCOCZL3&;2obdG?qZ>rD|zC|Lu|sny76pn2xl|6sk~Hs{X9{8iBW zwiwgQt+@hi`FYMEhX2 yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.