mirror of
https://github.com/Keycapsss/awesome-mechanical-keyboard.git
synced 2024-11-30 19:36:24 +03:00
Change structure for Gridsome
To make the content more unfriendly, i restructured the content and use [Gridsome](https://gridsome.org) as Static Site Generator. The content will be visible on https://keebfol.io and is still view-able on GitHub. Navigate to the docs folder.
This commit is contained in:
BenRoe
parent
94e7e05e1f
commit
30aabfbd5c
8
.gitignore
vendored
Executable file
8
.gitignore
vendored
Executable file
@ -0,0 +1,8 @@
|
||||
*.log
|
||||
.cache
|
||||
.DS_Store
|
||||
src/.temp
|
||||
node_modules
|
||||
dist
|
||||
.env
|
||||
.env.*
|
||||
204
README.md
Normal file → Executable file
204
README.md
Normal file → Executable file
@ -1,198 +1,18 @@
|
||||
# Awesome Mechanical Keyboard [](https://awesome.re)
|
||||
|
||||
## Table of Contents
|
||||
The goal of this repository is to collect mechanical keyboard related projects (preferably Open Source).
|
||||
|
||||
- [Keyboards](#keyboards)
|
||||
- [Ortholinear-Keyboards](#ortholinear-Keyboards)
|
||||
- [Handwired](#handwired)
|
||||
- [Numpad/Macropad](#numpadmacropad)
|
||||
- [Case](#case)
|
||||
- [Tools](#tools)
|
||||
- [Firmware](#firmware)
|
||||
- [Tutorials](#tutorials)
|
||||
- [Miscellaneous](#miscellaneous)
|
||||
View the pages on [Keebfol.io](https://keebfol.io) or GitHub:
|
||||
- [Keyboards](docs/Readme.md)
|
||||
- [Tools](docs/tools.md)
|
||||
- [Firmware](docs/firmware.md)
|
||||
- [Tutorials](docs/tutorials.md)
|
||||
- [Miscellaneous](docs/miscellaneous.md)
|
||||
|
||||
|
||||
## Keyboards
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | --- | --- |
|
||||
| [5plit](https://github.com/larrbo/odd-rocket/tree/master/5plit%20-kailh) | pcb, case | 4x5, plate, pro micro, kailh choc | <img src="https://2.bp.blogspot.com/-bmGeoE6LDsY/WuntJ_vPaJI/AAAAAAAABPs/hSzlyzQB9x0DCwZeqpAm8_qTjESYyPDIACLcBGAs/s400/yijoz5ywkzg01.jpg" width="200px"/> |
|
||||
| [ANHEDRAL](https://github.com/eswai/anhedral) | pcb, case | pro micro | <img src="https://github.com/eswai/anhedral/raw/master/anhedral1-1.jpeg" width="200px" /> |
|
||||
| [Akihabara](https://www.thingiverse.com/thing:3105838) | pcb, case | 40%, 3d print | <img src="https://cdn.thingiverse.com/renders/2a/ab/3d/2a/72/20404c338dddde183e41bf112c8b3bbb_preview_featured.jpg" width="200px"/> |
|
||||
| [Alpha](https://github.com/PyrooL/Alpha) | pcb, case | <30% | <img src="https://i.imgur.com/alNWnhZ.jpg" width="200px"/> |
|
||||
| [Apoptosis](https://github.com/pseudoku/Apoptosis) | pcb | 3x6, vertically staggered, thumb keys | <img src="https://raw.githubusercontent.com/pseudoku/Apoptosis/master/Apoptosis_PCB.jpg" width="200px" /> |
|
||||
| [Arisu Keyboard PCB](https://github.com/FateNozomi/arisu-pcb) | pcb, case | | <img src="https://camo.githubusercontent.com/52126fe22185eb48a922b8f7a2a2726cb2f19226/68747470733a2f2f692e696d6775722e636f6d2f6b6e74353138452e6a7067" width="200px" /> |
|
||||
| [Atreus](https://github.com/technomancy/atreus) | pcb, case | 40% | <img src="https://github.com/technomancy/atreus/raw/master/atreus.jpg" width="200px"/> |
|
||||
| [Atreus62](https://github.com/profet23/atreus62) | pcb, case | 60% | <img src="https://raw.githubusercontent.com/profet23/atreus62/master/images/nantucket-atreus62.jpg" width="200px"/> |
|
||||
| [CozyKeys Bloomer](https://github.com/cozykeys/bloomer) | pcb, case | 75%, underglow | <img src="https://camo.githubusercontent.com/d06fa0fd471810b747137c0828502567c2323fe3/687474703a2f2f6173736574732e636f7a796b6579732e78797a2f696d616765732f6b6579626f617264732f626c6f6f6d65722f626c6f6f6d65722d616e676c652d325f383030783830302e6a7067" width="200px"/> |
|
||||
| [Chimera Ergo/Ergo Mini/Ergo 42](https://github.com/GlenPickle/Chimera) | pcb | split, wireless, vertically staggered | <img src="https://i.imgur.com/AA6ycMQ.jpg" width="200px"> <img src="https://i.imgur.com/LAny3ue.jpg" width="200px"/> <img src="https://i.imgur.com/wfTsIKV.jpg" width="200px" /> |
|
||||
| [CPM43](https://github.com/Gtrx0/cpm43) | pcb | 40%, 4x12, underglow, atmega32U4, usb-c, esd | <img src="https://raw.githubusercontent.com/Gtrx0/cpm43/master/Renders/Render_Unpopulated_Front.png" width="200px" /> |
|
||||
| [Crkbd](https://github.com/foostan/crkbd) | pcb, case | split, oled, 3x6, vertically staggered, thumb keys, kailh choc | <img src="https://user-images.githubusercontent.com/736191/40575636-6fba63a4-6123-11e8-9ca0-3f990f1f9f4c.jpg" width="200px"/> |
|
||||
| [Crkbd x jian](https://github.com/kluelesskk/crkbd) | pcb, case | split, oled, 3x6, vertically staggered, thumb keys, kailh choc | <img src="https://i.imgur.com/QqnAWvG.jpg" width="200px" /> |
|
||||
| [ErgoDash](https://github.com/omkbd/ErgoDash) | pcb, case | 5x7, plate, led, split, thumb key | <img src="https://github.com/omkbd/picture/blob/master/Ergodash.jpg?raw=true" width="200px"/> |
|
||||
| [ErgoDash Mini](https://github.com/omkbd/ErgoDash/tree/master/mini) | pcb, case | 4x7, plate, led, split, thumb key | <img src="https://github.com/omkbd/picture/blob/master/Ergodashmini.jpg?raw=true" width="200px"/> |
|
||||
| [ErgoMac](https://github.com/LilBigMacky/ergomac) | pcb | split, vertically staggered, thumb keys | <img src="https://i.redd.it/6ndsci0gt0x11.jpg" width="200px"/> |
|
||||
| [ErgoTravel](https://github.com/jpconstantineau/ErgoTravel) | pcb, case | split, vertically staggered, thumb keys | <img src="https://i.imgur.com/DY0FxcM.jpg" width="200px"/> |
|
||||
| [Ergoinu](https://github.com/hsgw/ergoinu) | pcb, case | split, plate, mx, pro micro | <img src="https://raw.githubusercontent.com/wiki/hsgw/ergoinu/images/keyboard_top.JPG" width="200px"/> |
|
||||
| [Fortitude60](https://github.com/Pekaso/fortitude60) | pcb, case | 60%, 4x6, split, vertically staggered | <img src="https://camo.githubusercontent.com/b5a0fefe70132b6c9777bbba546fcd872d97ceae/68747470733a2f2f692e696d6775722e636f6d2f54627a6e7767672e6a7067" width="200px" /> |
|
||||
| [Fourier](https://github.com/keebio/fourier) | pcb | split, staggered | <img src="https://camo.githubusercontent.com/3dadc57ab6cb05e7d43de5b1570f60c645914347/68747470733a2f2f63646e2e73686f706966792e636f6d2f732f66696c65732f312f313835312f353132352f70726f64756374732f696d6167655f31643338373933632d656262362d346466382d626162352d3933333136323632386665355f3130323478313032344032782e6a70673f763d31353139393731373937" width="200px" /> |
|
||||
| [Gameboy Keyboard case](https://www.thingiverse.com/thing:3007828) | case, pcb | 3d print, pcb | <img src="https://cdn.thingiverse.com/renders/4c/5f/a1/08/09/5d5fe686b8dbcc86c38133f7487ddcf5_preview_featured.JPG" width="200px"/> |
|
||||
| [GH60](https://github.com/komar007/gh60) | pcb | 60%, atmega32U4 | <img src="http://blog.komar.be/wp-content/uploads/2016/05/pcb_back.png" width="200px"/> |
|
||||
| [HacKeyboard](https://github.com/masaleiro/HacKeyboard) | pcb, case | | <img src="https://cdn.instructables.com/F9P/KCPI/IGV4DBXA/F9PKCPIIGV4DBXA.LARGE.jpg" width="200px"/> |
|
||||
| [MiniDox pcb](https://github.com/That-Canadian/MiniDox_pcb) | pcb | split, 3x5, vertically staggered, thumb keys | <img src="https://camo.githubusercontent.com/d8925d5e754c3a8998db4ad9874c1d8b093901f2/687474703a2f2f692e696d6775722e636f6d2f69576233794f302e6a7067" width="200px"/> |
|
||||
| [Mitosis](https://github.com/reversebias/mitosis-hardware) | pcb, case | split, wireless | <img src="https://i.imgur.com/gApMkzz.jpg" width="200px"/> |
|
||||
| [Orbit](https://github.com/ai03-2725/Orbit) | pcb | split, 5x7, thumb keys, usb-c | <img src="https://raw.githubusercontent.com/ai03-2725/Orbit/master/Images/PCB-R1.5.jpg" width="200px"/> |
|
||||
| [Plain60-c](https://github.com/Maartenwut/plain60-c) | pcb | 60%, usb-c, atmega32U4 | <img src="https://camo.githubusercontent.com/85b21ccd9dfe95a86407fda6b1ee7ba14ec57bf4/68747470733a2f2f692e696d6775722e636f6d2f4f774f503956622e706e67" width="200px"/> |
|
||||
| [pteron](https://github.com/FSund/pteron-keyboard) | case | 3x5, 3x6, 4x6, handwiring, pro micro | <img src="https://camo.githubusercontent.com/9f0a06184893760528f1c5db991c5463d403b528/68747470733a2f2f692e696d6775722e636f6d2f395168506c56442e6a7067" width="200px"/> |
|
||||
| [Redox](https://github.com/mattdibi/redox-keyboard) | case | split, thumb keys, opensCad, 3d print | <img src="https://cdn.thingiverse.com/renders/62/c5/d6/91/6f/f23021b44a5e59a6838fc8b440fb8b56_preview_featured.jpg" width="200px"/> |
|
||||
| [SB-147](https://github.com/sealclubber/SB-147) | case | 3d print, handwiring | <img src="https://i.imgur.com/VWGHzfU.jpg" width="200px" /> |
|
||||
| [Tanuki](https://github.com/SethSenpai/Tanuki) | pcb, case | 40%, underglow | <img src="https://github.com/SethSenpai/Tanuki/raw/master/Img/glamour1.jpg" width="200px"/> |
|
||||
| [Tg4x](https://github.com/MythosMann/tg4x) | pcb, case | pro micro, 40% | <img src="https://raw.githubusercontent.com/MythosMann/tg4x/master/pcb_raytrace.png" width="200px"/> |
|
||||
| [Ultimate Hacking Keyboard](https://github.com/UltimateHackingKeyboard/electronics) | pcb | split, display, 31FL3731 | <img src="https://ultimatehackingkeyboard.com/wordpress/wp-content/uploads/2018/07/uhk-split-palm-rest-1920.jpg" width="200px"/> |
|
||||
| [Voyager](https://github.com/ai03-2725/Voyager) | pcb | 60%, ansi, iso, rgb, led | <img src="https://raw.githubusercontent.com/ai03-2725/Voyager104/master/Renders/Front.png" width="200px"/> |
|
||||
| [XMMX TKL](https://geekhack.org/index.php?topic=93422.0) | pcb | | <img src="https://i.imgur.com/otn8LT3.jpg" width="200px"/> |
|
||||
| []() | | | |
|
||||
|
||||
## Ortholinear-Keyboards
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | --- | --- |
|
||||
| [Alpsie](https://github.com/larrbo/odd-rocket/tree/master/alpsie) | pcb, case | 4x12, pro micro, alps, plate | <img src="https://3.bp.blogspot.com/-IAVUSnTmtZA/XArbAHFK5wI/AAAAAAAABeE/FKTl072R1CkIZwXr4AVCZ-_qG7uRjHw9wCLcBGAs/s640/IMG_20181128_194036.jpg" width="200px"/> |
|
||||
| [Chimera Ortho](https://github.com/GlenPickle/Chimera) | pcb | split, wireless | <img src="https://i.imgur.com/WqYzK5J.jpg" width="200px"/> |
|
||||
| [Contra](https://github.com/ai03-2725/Contra) | pcb | 4x12 | <img src="https://cartel.ltd/wp-content/uploads/bfi_thumb/contra_p02_02-nktu82ndud49t3w6hk7enn5y4vcjr4ouv2513udte4.jpg" width="200px" /> |
|
||||
| [Dactyl](https://github.com/adereth/dactyl-keyboard) | pcb, case | split, thumb keys, 5x6, 60%, 3d print | <img src="https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png" width="200px"/> |
|
||||
| [Dactyl-ManuForm](https://github.com/tshort/dactyl-keyboard) | pcb, case | split, thumb keys, 4x5, 5x6, 40%, 60%, 3d print | <img src="https://camo.githubusercontent.com/a8dc88b0a973913a28a2373a7f3a9a3031af2672/687474703a2f2f692e696d6775722e636f6d2f4c646a456872522e6a7067" width="200px"/> |
|
||||
| [DIY Low-Profile Ortholinear](https://www.reddit.com/r/MechanicalKeyboards/comments/8sy17h/diy_low_profile_ortho/) ([PCB File](https://easyeda.com/7zark7/Kailh-Ortholinear)) | pcb | 14x6, low profile, teensy | <img src="https://i.imgur.com/cfNpqEE.jpg" width="200px" /> |
|
||||
| [DMOTE](https://github.com/veikman/dactyl-keyboard) | case | concave, thumb keys, split, alps, mx | <img src="https://camo.githubusercontent.com/85b0066d64467a10e0d0bcbdde26e6726eb95fde/687474703a2f2f76696b746f722e65696b6d616e2e73652f696d6167652f646d6f74652d322d746f702d646f776e2d766965772f646973706c6179" width="200px"/> |
|
||||
| [ErgoDox official](https://github.com/Ergodox-io) | pcb, acryl case, 3d printable case | split, thumb keys, 5x7, 3d print | <img src="https://github.com/Ergodox-io/ergodox-io/blob/master/src/img/ErgoDox-original-min.png" width="200px" /> |
|
||||
| [Ergo42](https://github.com/Biacco42/Ergo42) | pcb, case | split, 4x7 | <img src="https://raw.githubusercontent.com/Biacco42/Ergo42/readme/readme_image/ergo42_image.jpg" width="200px"/> |
|
||||
| [Gherkin](https://github.com/math0ne/keyboard-gherkin) | pcb | 30%, 3x10 | <img src="https://github.com/math0ne/keyboard-gherkin/raw/master/pcb/pcb-front.png" width="200px"/> |
|
||||
| [Helix](https://github.com/MakotoKurauchi/helix) | pcb, case | split, oled | <img src="https://camo.githubusercontent.com/348c95ff3baea20626e282b1a719eea49d0897b9/68747470733a2f2f692e696d6775722e636f6d2f5842416d796e4e2e6a7067" width="200px"/> |
|
||||
| [Koda](https://github.com/larrbo/odd-rocket/tree/master/koda) | pcb, case | 4x12, pro micro, kailh choc | <img src="https://4.bp.blogspot.com/-E9gGZbziicI/WwoNKDP-YPI/AAAAAAAABYk/IXV4gGrcQKo5Bqf7CRVpR_zYH2SCxAXwACLcBGAs/s400/IMG_20180522_231738.jpg" width="200px"/> |
|
||||
| [Lily58](https://github.com/kata0510/Lily58) | pcb, case | split, oled, 4x6 | <img src="https://user-images.githubusercontent.com/6285554/47264498-53384a80-d553-11e8-907a-a03c6f2c5893.JPG" width="200px"/> |
|
||||
| [Let's Split](https://github.com/climbalima/let-s-Split-v2) | pcb, [case](https://qmk.fm/keyboards/lets_split/) | split | <img src="https://camo.githubusercontent.com/dfbf83ee712079b862fccb951aefbb508b8a631d/687474703a2f2f692e696d6775722e636f6d2f797551754e4a552e6a7067" width="200px"/> |
|
||||
| [Manta 60](https://github.com/KamoNanban/Manta60) | pcb, case | 5x14, split, pro micro | <img src="https://pbs.twimg.com/media/Dy80wXGU0AAGZdK.jpg:large" width="200px" /> |
|
||||
| [Medusa](https://github.com/Gtrx0/Medusa) | pcb, case | 5x7, split, plate, bluetooth, nrf51822 | <img src="https://raw.githubusercontent.com/Gtrx0/Medusa/master/Renders/Front_Unpopulated.png?token=Anj1gDvVpb9Dt8Z8Zj3Az4azN7Fm_8hTks5bm9WJwA%3D%3D" width="200px" /> |
|
||||
| [Minisplit](https://github.com/kata0510/minisplit) | pcb, case | split, 4x6 | <img src="https://camo.githubusercontent.com/74766a3dbaf2b8a9ab8dae5c6cf656a7a0b9a9ac/68747470733a2f2f692e696d6775722e636f6d2f7a7767417251562e706e67" width="200px"/> |
|
||||
| [Plaid](https://github.com/hsgw/plaid) | pcb | 4x12, atmega328p | <img src="https://user-images.githubusercontent.com/2714926/49872071-481ae000-fe5b-11e8-963d-8aaa3a653e4d.jpg" width="200px"/> |
|
||||
| [Planck THK](https://github.com/olkb/planck_thk) | pcb, case | 4x12, rotary encoder | <img src="https://i.imgur.com/Jiy1jLN.jpg" width="200px"/> |
|
||||
| [QOL56](https://github.com/eswai/QOL56) | pcb, case | 4x14, pro micro, underglow, rgb | <img src="https://github.com/eswai/QOL56/raw/master/qol56-7.jpg" width="200px" /> |
|
||||
| [Science](https://github.com/peej/for-science-keyboard) | pcb | split, arduino, 5x5| <img src="https://camo.githubusercontent.com/fecf6f7bca9ec8b93e4031caa1ca3442cfb5a5f1/68747470733a2f2f692e696d6775722e636f6d2f666a6e546b42312e6a7067" width="200px"/> |
|
||||
| [SharkPCB](https://github.com/Gondolindrim/SharkPCB) | pcb, case | 4x12, rotary encoder, STM32, underglow, 3d print | <img src="https://github.com/Gondolindrim/SharkPCB/blob/master/renders/high/high1.png?raw=true" width="200px" /> |
|
||||
| [Split Infinitive](https://github.com/peej/for-split-keyboard/blob/master/README.md) | pcb | split, 5x6, pro micro | <img src="https://github.com/peej/for-split-keyboard/raw/master/pcb.png" width="200px"/> |
|
||||
| [Zen (RGBKB)](https://github.com/RGBKB/Keyboard-files/tree/master/Zen) [Build Guide](https://legonut.gitbooks.io/zen-keyboard/content/) | pcb, case | split, ergo, ortho, thumb keys, rgb led | <img src="https://camo.githubusercontent.com/6bf0257847f1e1972cfd6b9f289a6e8180163ff8/68747470733a2f2f692e696d6775722e636f6d2f7a337630416b732e6a7067" width="200px" /> |
|
||||
| []() | | | |
|
||||
|
||||
## Handwired
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | --- | --- |
|
||||
| [Arke](https://www.thingiverse.com/thing:2879329) | case | 3d print, split, pro micro | <img src="https://cdn.thingiverse.com/renders/42/c6/fc/55/83/38d59e181f2a3c892fe3f8365d00076e_preview_featured.jpg" width="200px" /> |
|
||||
| [Atreis](https://github.com/dekonnection/atreis) | case | handwiring | <img src="https://github.com/dekonnection/atreis/raw/master/pictures/GPI0El4.jpg" width="200px"/> |
|
||||
| [Atreus Split Keyboard](https://www.thingiverse.com/thing:1646718) | case | 3d print, split, pro micro | <img src="https://cdn.thingiverse.com/renders/2a/35/f6/bd/51/ee77cfa99ac6c721974f6eb92a52cce9_preview_featured.jpg" width="200px" /> |
|
||||
| [Ergo-Warped](https://github.com/pseudoku/ErgoWarp) | case | 3d print, split, ergo | <img src="https://raw.githubusercontent.com/pseudoku/Warped-keyboard/master/Photo/Proto6.jpg" width="200px" /> |
|
||||
| [Keyberon](https://github.com/TeXitoi/keyberon) | case, firmware | 3d print, handwiring, blue pill, ortholinear | <img src="https://raw.githubusercontent.com/TeXitoi/keyberon/master/images/keyberon.jpg" width="200px" /> |
|
||||
| [Mechanical Gamepad](https://www.thingiverse.com/thing:2593692) | case | 3d print, handwiring, pro micro, ortholinear | <img src="https://cdn.thingiverse.com/renders/61/74/20/bf/6f/387305d39edce0ec7409172e37eee126_preview_featured.jpg" width="200px" /> |
|
||||
| [Redox Manuform](https://www.thingiverse.com/thing:3503380) | case | 3d print, split, pro micro, underglow | <img src="https://cdn.thingiverse.com/renders/f5/89/b2/6b/a1/8d89de5ce484ac624324fb657f01e06e_preview_featured.jpg" width="200px" /> |
|
||||
| [SiCK-68](https://www.thingiverse.com/thing:3478494) | case | staggered, tkl, 3d print, handwiring, teensy | <img src="https://cdn.thingiverse.com/renders/b3/55/75/9b/d4/f20d6cca0ecda40347ad1802a63e518c_preview_featured.JPG" width="200px" /> |
|
||||
| [Tada68](https://www.thingiverse.com/thing:3372910) | case | 3d print, handwiring, teensy, tkl, staggered | <img src="https://cdn.thingiverse.com/renders/46/14/9d/aa/0e/8b1db0b24fc25d806e61f7b51671bd08_preview_featured.JPG" width="200px" /> |
|
||||
| []() | | | |
|
||||
|
||||
## Numpad/Macropad
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | --- | --- |
|
||||
| [4x5-wireless-keypad-pcb](https://github.com/ogatatsu/4x5-wireless-keypad-pcb) | pcb | 4x5, bluetooth | <img src="https://github.com/ogatatsu/4x5-wireless-keypad-pcb/blob/master/images/1.png?raw=true" width="200px" /> |
|
||||
| [Amoeba Single-Switch PCB](https://github.com/mtl/keyboard-pcbs) | pcb | single-switch, handwiring | <img src="https://deskthority.net/resources/image/25215" width="200px"/> |
|
||||
| [Cherry-Mx-Bitboard-Re](https://github.com/ogatatsu/Cherry-Mx-Bitboard-Re) | pcb | single-switch, handwiring, hotswap | <img src="https://github.com/ogatatsu/Cherry-Mx-Bitboard-Re/raw/master/Images/a.jpeg" width="200px" /> |
|
||||
| [Cherry MX Keypad](http://syncchannel.blogspot.com/2016/06/cherry-mx-keypad.html?m=1) | pcb | 1x4, led | <img src="https://1.bp.blogspot.com/-Mur6fIsKDwU/V1NmGd7T4QI/AAAAAAAAAyU/Fh40F8Zl41YVosa03zkJl2WPSQ7sGS_AwCLcB/s280/CherryMXkeypad1.jpg" width="200px"/> |
|
||||
| [Cookpad Pad](https://github.com/cookpad/cookpad-pad) | pcb, case | 2x3, pro micro, ws2812b, underglow | <img src="https://github.com/cookpad/cookpad-pad/raw/master/docs/images/cookpad-pad.jpg" width="200px" /> |
|
||||
| [Game cart macropad](https://www.thingiverse.com/thing:3029578) | pcb, case | 4x4, 3d print | <img src="https://cdn.thingiverse.com/renders/f2/ab/f5/bd/7a/590674241125b3f375c064646978a1d0_preview_featured.jpg" width="200px"/> |
|
||||
| [GeekPad](https://git.bthlabs.pl/tomekwojcik/geekpad/) | pcb, case | 3x3, 3d print | <img src="https://i.imgur.com/FEzO81l.jpg" width="200px"/> |
|
||||
| [Kbord](https://github.com/dekuNukem/kbord) | pcb, case | 5x3, oled, rgb, sd-card | <img src="https://github.com/dekuNukem/kbord/raw/master/pics/title.jpg" width="200px"/> |
|
||||
| [LFK17](https://github.com/lfkeyboards/lfk17) | pcb | 5x4, numpad, hotswap, rgb | <img src="https://i.imgur.com/N4x5wXp.jpg" width="200px"/> |
|
||||
| [Lysergic 25](https://github.com/Gtrx0/lysergic25) | pcb, plate | 5x5, pro micro, plate, underglow, ws2812b, esd, usb-c | <img src="https://raw.githubusercontent.com/Gtrx0/lysergic25/master/Renders/Backside_populated.png" width="200px" /> |
|
||||
| [Meishi2](https://github.com/Biacco42/meishi2) | pcb | 1x4, pro micro | <img src="https://i.imgur.com/2SQqVlZ.png" width="200px"/> |
|
||||
| [SAMD21 Bridge Module Cherry Board](https://www.pcbway.com/project/shareproject/DIY_RGB_Cherry_MX_Hotkey_Board.html) | pcb, case | plate | <img src="https://file.pcbway.com/websponsor/18/07/26/195654072.jpg" width="200px" /> |
|
||||
| [Zesty 25](https://github.com/Gtrx0/zesty25) | pcb, case | 5x5, pro micro, plate, underglow, ws2812b | <img src="https://raw.githubusercontent.com/Gtrx0/zesty25/master/Renders/Backside_Unpopulated.png" width="200px" /> |
|
||||
| []() | | | |
|
||||
|
||||
## Case
|
||||
| Name | Tags | Image |
|
||||
| --- | --- | --- |
|
||||
| [60% (Poker II, Pok3r) Keyboard Case 2.0](https://www.thingiverse.com/thing:983332) | 3d print | <img src="https://cdn.thingiverse.com/renders/8a/ac/f9/d8/ad/zanmYsB_-_Imgur_preview_featured.jpg" width="200px" /> |
|
||||
| [Arisu Keyboard Case](https://github.com/FateNozomi/arisu-case) | plate | <img src="https://camo.githubusercontent.com/52126fe22185eb48a922b8f7a2a2726cb2f19226/68747470733a2f2f692e696d6775722e636f6d2f6b6e74353138452e6a7067" width="200px" /> |
|
||||
| [Atreus62 High Profile Keyboard Case](https://www.thingiverse.com/thing:3246981) | 3d print | <img src="https://cdn.thingiverse.com/renders/e5/f1/48/84/33/5c363031158a92007b63b0468cea95c6_preview_featured.jpg" width="200px" /> |
|
||||
| [Chimera Egro 42 Tenting Case](https://github.com/wizarddata/Chimera-Egro-42-Case) | 3d print, tenting, split | |
|
||||
| [Cospad Case](https://www.thingiverse.com/thing:3233852) | 3d print, numpad | <img src="https://cdn.thingiverse.com/renders/23/ce/51/e6/60/c529ac4f1f85fb603e729532d6a4e3a5_preview_featured.jpg" width="200px" /> |
|
||||
| [Cospad Diamond Case](https://www.thingiverse.com/thing:3389713) | 3d print, numpad | <img src="https://cdn.thingiverse.com/renders/85/59/4f/c2/34/05af4ff61e5c7829934b3206dd96247e_preview_featured.jpg" width="200px" /> |
|
||||
| [Dactyl extended bottom case with gel wrist rests](https://www.thingiverse.com/thing:2436848) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/36/ef/6d/5f/59/c7a62cce09db90af7db2c013ccf94171_preview_featured.jpg" width="200px" /> |
|
||||
| [ErgoDash Tenting Case](https://github.com/wizarddata/Ergodash-Case) | 3d printing, split, tenting | |
|
||||
| [ErgoDox-Case](https://github.com/CharlesLenk/ErgoDox-Case) | split, thumb keys, 7x5 | |
|
||||
| [Ergodox Case](https://www.thingiverse.com/thing:753448) | 3d print | <img src="https://cdn.thingiverse.com/renders/4e/a2/85/36/dd/TopRightCase_preview_featured.jpg" width="200px" /> |
|
||||
| [Ergodox Case PrintDox](https://www.thingiverse.com/thing:2533064) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/cf/a4/a1/db/34/c62c3dfe57add30ddfdd10bba6959503_preview_featured.jpg" width="200px" /> |
|
||||
| [Fourier - Split 40% Keybaord](https://www.thingiverse.com/thing:3456985) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/95/4a/57/83/a5/c67e7861a9923e60be38f20b33bc8989_preview_featured.jpg" width="200px"/> |
|
||||
| [Iris Case](https://www.thingiverse.com/thing:3545130) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/c7/49/9a/e9/85/9781426efbd02367f1796f20f4918e63_preview_featured.jpg" width="200px" /> |
|
||||
| [Iris Case V2](https://www.thingiverse.com/thing:3186129) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/ce/f1/6f/c4/1c/b10ee16c8aef868230d6b430237876b4_preview_featured.jpg" width="200px" /> |
|
||||
| [Iris Ice Project](https://github.com/rs/iris-ice) | 3d print, acrylic, white, led | <img src="https://github.com/rs/iris-ice/blob/master/img/iris-ice.jpg?raw=true" width="200px"/> |
|
||||
| [Iris Tenting Cases (High & Low Profile)](https://github.com/wizarddata/Iris-Case) | 3d print, tenting, split | |
|
||||
| [Let's Split Keyboard Angled Case](https://www.thingiverse.com/thing:2626039) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/e8/05/1a/03/99/429c22d5f6e9df54f0b98e73d0ec0a19_preview_featured.jpg" width="200px"/> |
|
||||
| [Let's Split Keyboard Case](https://www.thingiverse.com/thing:2482218) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/0f/cb/dc/ad/ac/f3ccdd27d2000e3f9255a7e3e2c48800_preview_featured.jpg" width="200px"/> |
|
||||
| [Let's Split Keyboard Plate & Case](https://www.thingiverse.com/thing:2335558) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/79/08/a0/f0/87/73727bf9538c5aa7b80ac16c14c6686b_preview_featured.jpg" width="200px" /> |
|
||||
| [Minidox Case](https://github.com/dotdash32/cases/tree/master/Minidox) | split, 3x6, vertically staggered, thumb keys | <img src="https://camo.githubusercontent.com/b345769866acbd0ad76c22250941aa4ab23667e5/68747470733a2f2f692e696d6775722e636f6d2f686d6e6b56646e2e6a7067" width="200px"/> |
|
||||
| [Minidox Tenting Case](https://github.com/wizarddata/Minidox-Cases) | 3d print, tenting, split | |
|
||||
| [Miuni32-Case](https://github.com/wizarddata/Miuni32-Case) | 3d print, ortholinear, 3x11 | <img src="https://preview.redd.it/da5ey5fxfyp21.jpg?width=960&crop=smart&auto=webp&s=470ec31cd4ad760dd30c16591740b238fa8a59cc" width=200px /> |
|
||||
| [Nyquist Plate + Case](https://www.thingiverse.com/thing:2389357) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/81/82/66/eb/3d/7b3575db20022d9ffa547ea4deb728d1_preview_featured.jpg" width="200px" /> |
|
||||
| [OLKB (Planck, Preonic & Atomic)](https://github.com/olkb/olkb_parts) | 3d print, plate | |
|
||||
| [Redox-Case](https://github.com/Lenbok/scad-redox-case) | split, thumb keys, opensCad, 3d print | <img src="https://github.com/Lenbok/scad-redox-case/raw/master/images/redox-exploded.png" width="200px"/> |
|
||||
| []() | | |
|
||||
|
||||
## Tools
|
||||
- [ai03 Plate Generator](https://kbplate.ai03.me) - An advanced plate generator which doesn't result in 13.99999mm cutouts. [GitHub Repo](https://github.com/ai03-2725/another-keyboard-builder)
|
||||
- [Kalerator](https://kalerator.clueboard.co) - Pcb generator for keyboard-layout-editor generated layouts. [GitHub Site](https://github.com/skullydazed/kalerator), [Eagle Parts Library](https://github.com/skullydazed/clueboard_eagle)
|
||||
- [kbpcb](http://kbpcb.mrkeebs.com/) - Create KiCad PCB files from [KLE](http://www.keyboard-layout-editor.com) json files. [GitHub page](https://github.com/fcoury/kbpcb)
|
||||
- [Keyboard Firmware Builder](https://kbfirmware.com) - Online QMK Firmware Builder (2+ years behind QMK firmware master).
|
||||
- [keyboard-layout-editor](http://www.keyboard-layout-editor.com/) - Is a web application that enables the editing of keyboard-layouts, i.e., the position and appearance of each physical key. [GitHub Site](https://github.com/ijprest/keyboard-layout-editor)
|
||||
- [Keyboard Layout 3D Viewer](https://github.com/eswai/KL3V) - 3D render keyboard-layout-editor.com layouts.
|
||||
- [kle_render](https://github.com/CQCumbers/kle_render) - Get prettier images of Keyboard Layout Editor designs.
|
||||
- [Parametric Mechanical Keycap Library](https://github.com/rsheldiii/KeyV2) - Is a keycap and keyset construction library for mechanical keyboards, written in openSCAD.
|
||||
- [Plate & Case Builder](http://builder.swillkb.com) - Keyboard top plate CAD files generator, for keyboard-layout-editor generated layouts.
|
||||
- [Q2K](https://github.com/2hwk/Q2K) - A python based utility for parsing QMK Firmware keymaps to various outputs.
|
||||
- [QMK Configurator](https://config.qmk.fm/) - An open source configurator for QMK Firmware.
|
||||
- [kbd-prettier](https://github.com/blakedietz/kbd-prettier) - Automatically format your keyboard layout.
|
||||
|
||||
## Firmware
|
||||
- [BlueMicro_BLE](https://github.com/jpconstantineau/BlueMicro_BLE) - A Bluetooth Firmware for the NRF52832.
|
||||
- [Bluetosis](https://github.com/geoah/bluetosis) - Bluetooth firmware for the Mitosis keyboard.
|
||||
- [Kaleidoscope](https://github.com/keyboardio/Kaleidoscope)
|
||||
- [Keyplus](https://github.com/ahtn/keyplus)
|
||||
- [QMK](https://github.com/qmk/qmk_firmware)
|
||||
- [TMK](https://github.com/tmk/tmk_keyboard)
|
||||
|
||||
|
||||
## Tutorials
|
||||
- [A modern handwiring guide](https://geekhack.org/index.php?topic=87689.0)
|
||||
- [Hand wiring a let's split](https://johannes-jansson.github.io/projects/2018/07/23/hand-wiring-lets-split.html) - Guide using a pro micro, covering everything from soldering to programming a split keyboard.
|
||||
- [How to integrate a trackpoint in a mechanical keyboard (TMK, Teensy)](https://github.com/alonswartz/trackpoint)
|
||||
- [Keyboard PCB Guide](https://github.com/ruiqimao/keyboard-pcb-guide/blob/master/README.md)
|
||||
- [lets-split-guide](https://github.com/nicinabox/lets-split-guide) - This guide covers building a Let's Split v2.
|
||||
- [The Keyboard Matrix](http://blog.komar.be/how-to-make-a-keyboard-the-matrix/) - How a keyboard matrix work, explained in depth.
|
||||
- [The Keyboard Matrix 2](https://www.dribin.org/dave/keyboard/one_html/) - Another explanation how a keyboard matrix work and why it needs diodes.
|
||||
|
||||
## Miscellaneous
|
||||
- [BLE Micro Pro](https://github.com/sekigon-gonnoc/BLE-Micro-Pro) - Breakout board of BL654(nrf52840 module) which is almost compatible with Pro Micro. This board is designed for wireless split DIY keyboards.
|
||||
- [Cherry Popper](https://www.thingiverse.com/thing:2685653) - 3D printable Mechanical Keyboard Switch Opening Tool.
|
||||
- [Keyrigami](https://github.com/geckopfote/keyrigami) - Keycaps made from paper.
|
||||
- [Kailh-Low-Profile-Keycap](https://github.com/ogatatsu/Kailh-Low-Profile-Keycap) - Kailh Low Profile Keycap 3D files.
|
||||
- [KiCad Parts by Ai03](https://github.com/ai03-2725/MX_Alps_Hybrid.pretty) - KiCad Library of custom MX-Alps footprints.
|
||||
- [KiCad Parts by Daprice](https://github.com/daprice/keyswitches.pretty) - KiCAD footprint library for kailh choc and MX-style mechanical switches.
|
||||
- [KiCad Parts by Keebio](https://github.com/keebio/Keebio-Parts.pretty) - Various KiCAD footprints for mechanical keyboard parts.
|
||||
- [KiCAD Parts by TMK](https://github.com/tmk/keyboard_parts.pretty) - KiCad modules for keyboard design.
|
||||
- [Keyswitch Datasheets](https://github.com/keyboardio/keyswitch_documentation)
|
||||
- [List of split keyboards](https://docs.google.com/spreadsheets/d/19-rTWbp8SCKdZFByPZu3RT8NSF8vVddDe8WL6R6b1qQ/edit?usp=sharing)
|
||||
- QMK Proton C symbol/footprint for [KiCad](https://github.com/qmk/qmk_hardware/tree/master/kicad/proton_c), [Eagle](https://github.com/qmk/qmk_hardware/tree/master/eagle)
|
||||
- [XDA Keycap 3D Models](https://github.com/spooknik/XDA-Keycaps)
|
||||
|
||||
---
|
||||
### Contributing
|
||||
Contributions welcome!
|
||||
Contributions are welcome!
|
||||
To add content, edit the Markdown file in the [docs](docs/) folder and open a [Pull Request](https://help.github.com/en/articles/about-pull-requests). You can also open a new [Issue](https://github.com/BenRoe/awesome-mechanical-keyboard/issues).
|
||||
|
||||
The project uses [Gridsome](https://gridsome.org) as a Static Site Generator.
|
||||
|
||||
### License
|
||||
[](https://creativecommons.org/publicdomain/zero/1.0/)
|
||||
[](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
|
||||
130
docs/README.md
Normal file
130
docs/README.md
Normal file
@ -0,0 +1,130 @@
|
||||
|
||||
## Keyboards
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | :---: | :---: |
|
||||
| [5plit](https://github.com/larrbo/odd-rocket/tree/master/5plit%20-kailh) | pcb, case | 4x5, plate, pro micro, kailh choc | <img src="https://2.bp.blogspot.com/-bmGeoE6LDsY/WuntJ_vPaJI/AAAAAAAABPs/hSzlyzQB9x0DCwZeqpAm8_qTjESYyPDIACLcBGAs/s400/yijoz5ywkzg01.jpg" width="200px"/> |
|
||||
| [ANHEDRAL](https://github.com/eswai/anhedral) | pcb, case | pro micro | <img src="https://github.com/eswai/anhedral/raw/master/anhedral1-1.jpeg" width="200px" /> |
|
||||
| [Akihabara](https://www.thingiverse.com/thing:3105838) | pcb, case | 40%, 3d print | <img src="https://cdn.thingiverse.com/renders/2a/ab/3d/2a/72/20404c338dddde183e41bf112c8b3bbb_preview_featured.jpg" width="200px"/> |
|
||||
| [Alpha](https://github.com/PyrooL/Alpha) | pcb, case | <30% | <img src="https://i.imgur.com/alNWnhZ.jpg" width="200px"/> |
|
||||
| [Apoptosis](https://github.com/pseudoku/Apoptosis) | pcb | 3x6, vertically staggered, thumb keys | <img src="https://raw.githubusercontent.com/pseudoku/Apoptosis/master/Apoptosis_PCB.jpg" width="200px" /> |
|
||||
| [Arisu Keyboard PCB](https://github.com/FateNozomi/arisu-pcb) | pcb, case | | <img src="https://camo.githubusercontent.com/52126fe22185eb48a922b8f7a2a2726cb2f19226/68747470733a2f2f692e696d6775722e636f6d2f6b6e74353138452e6a7067" width="200px" /> |
|
||||
| [Atreus](https://github.com/technomancy/atreus) | pcb, case | 40% | <img src="https://github.com/technomancy/atreus/raw/master/atreus.jpg" width="200px"/> |
|
||||
| [Atreus62](https://github.com/profet23/atreus62) | pcb, case | 60% | <img src="https://raw.githubusercontent.com/profet23/atreus62/master/images/nantucket-atreus62.jpg" width="200px"/> |
|
||||
| [CozyKeys Bloomer](https://github.com/cozykeys/bloomer) | pcb, case | 75%, underglow | <img src="https://camo.githubusercontent.com/d06fa0fd471810b747137c0828502567c2323fe3/687474703a2f2f6173736574732e636f7a796b6579732e78797a2f696d616765732f6b6579626f617264732f626c6f6f6d65722f626c6f6f6d65722d616e676c652d325f383030783830302e6a7067" width="200px"/> |
|
||||
| [Chimera Ergo/Ergo Mini/Ergo 42](https://github.com/GlenPickle/Chimera) | pcb | split, wireless, vertically staggered | <img src="https://i.imgur.com/AA6ycMQ.jpg" width="200px"> <img src="https://i.imgur.com/LAny3ue.jpg" width="200px"/> <img src="https://i.imgur.com/wfTsIKV.jpg" width="200px" /> |
|
||||
| [CPM43](https://github.com/Gtrx0/cpm43) | pcb | 40%, 4x12, underglow, atmega32U4, usb-c, esd | <img src="https://raw.githubusercontent.com/Gtrx0/cpm43/master/Renders/Render_Unpopulated_Front.png" width="200px" /> |
|
||||
| [Crkbd](https://github.com/foostan/crkbd) | pcb, case | split, oled, 3x6, vertically staggered, thumb keys, kailh choc | <img src="https://user-images.githubusercontent.com/736191/40575636-6fba63a4-6123-11e8-9ca0-3f990f1f9f4c.jpg" width="200px"/> |
|
||||
| [Crkbd x jian](https://github.com/kluelesskk/crkbd) | pcb, case | split, oled, 3x6, vertically staggered, thumb keys, kailh choc | <img src="https://i.imgur.com/QqnAWvG.jpg" width="200px" /> |
|
||||
| [ErgoDash](https://github.com/omkbd/ErgoDash) | pcb, case | 5x7, plate, led, split, thumb key | <img src="https://github.com/omkbd/picture/blob/master/Ergodash.jpg?raw=true" width="200px"/> |
|
||||
| [ErgoDash Mini](https://github.com/omkbd/ErgoDash/tree/master/mini) | pcb, case | 4x7, plate, led, split, thumb key | <img src="https://github.com/omkbd/picture/blob/master/Ergodashmini.jpg?raw=true" width="200px"/> |
|
||||
| [ErgoMac](https://github.com/LilBigMacky/ergomac) | pcb | split, vertically staggered, thumb keys | <img src="https://i.redd.it/6ndsci0gt0x11.jpg" width="200px"/> |
|
||||
| [ErgoTravel](https://github.com/jpconstantineau/ErgoTravel) | pcb, case | split, vertically staggered, thumb keys | <img src="https://i.imgur.com/DY0FxcM.jpg" width="200px"/> |
|
||||
| [Ergoinu](https://github.com/hsgw/ergoinu) | pcb, case | split, plate, mx, pro micro | <img src="https://raw.githubusercontent.com/wiki/hsgw/ergoinu/images/keyboard_top.JPG" width="200px"/> |
|
||||
| [Fortitude60](https://github.com/Pekaso/fortitude60) | pcb, case | 60%, 4x6, split, vertically staggered | <img src="https://camo.githubusercontent.com/b5a0fefe70132b6c9777bbba546fcd872d97ceae/68747470733a2f2f692e696d6775722e636f6d2f54627a6e7767672e6a7067" width="200px" /> |
|
||||
| [Fourier](https://github.com/keebio/fourier) | pcb | split, staggered | <img src="https://camo.githubusercontent.com/3dadc57ab6cb05e7d43de5b1570f60c645914347/68747470733a2f2f63646e2e73686f706966792e636f6d2f732f66696c65732f312f313835312f353132352f70726f64756374732f696d6167655f31643338373933632d656262362d346466382d626162352d3933333136323632386665355f3130323478313032344032782e6a70673f763d31353139393731373937" width="200px" /> |
|
||||
| [Gameboy Keyboard case](https://www.thingiverse.com/thing:3007828) | case, pcb | 3d print, pcb | <img src="https://cdn.thingiverse.com/renders/4c/5f/a1/08/09/5d5fe686b8dbcc86c38133f7487ddcf5_preview_featured.JPG" width="200px"/> |
|
||||
| [GH60](https://github.com/komar007/gh60) | pcb | 60%, atmega32U4 | <img src="http://blog.komar.be/wp-content/uploads/2016/05/pcb_back.png" width="200px"/> |
|
||||
| [HacKeyboard](https://github.com/masaleiro/HacKeyboard) | pcb, case | | <img src="https://cdn.instructables.com/F9P/KCPI/IGV4DBXA/F9PKCPIIGV4DBXA.LARGE.jpg" width="200px"/> |
|
||||
| [MiniDox pcb](https://github.com/That-Canadian/MiniDox_pcb) | pcb | split, 3x5, vertically staggered, thumb keys | <img src="https://camo.githubusercontent.com/d8925d5e754c3a8998db4ad9874c1d8b093901f2/687474703a2f2f692e696d6775722e636f6d2f69576233794f302e6a7067" width="200px"/> |
|
||||
| [Mitosis](https://github.com/reversebias/mitosis-hardware) | pcb, case | split, wireless | <img src="https://i.imgur.com/gApMkzz.jpg" width="200px"/> |
|
||||
| [Orbit](https://github.com/ai03-2725/Orbit) | pcb | split, 5x7, thumb keys, usb-c | <img src="https://raw.githubusercontent.com/ai03-2725/Orbit/master/Images/PCB-R1.5.jpg" width="200px"/> |
|
||||
| [Plain60-c](https://github.com/Maartenwut/plain60-c) | pcb | 60%, usb-c, atmega32U4 | <img src="https://camo.githubusercontent.com/85b21ccd9dfe95a86407fda6b1ee7ba14ec57bf4/68747470733a2f2f692e696d6775722e636f6d2f4f774f503956622e706e67" width="200px"/> |
|
||||
| [pteron](https://github.com/FSund/pteron-keyboard) | case | 3x5, 3x6, 4x6, handwiring, pro micro | <img src="https://camo.githubusercontent.com/9f0a06184893760528f1c5db991c5463d403b528/68747470733a2f2f692e696d6775722e636f6d2f395168506c56442e6a7067" width="200px"/> |
|
||||
| [Redox](https://github.com/mattdibi/redox-keyboard) | case | split, thumb keys, opensCad, 3d print | <img src="https://cdn.thingiverse.com/renders/62/c5/d6/91/6f/f23021b44a5e59a6838fc8b440fb8b56_preview_featured.jpg" width="200px"/> |
|
||||
| [SB-147](https://github.com/sealclubber/SB-147) | case | 3d print, handwiring | <img src="https://i.imgur.com/VWGHzfU.jpg" width="200px" /> |
|
||||
| [Tanuki](https://github.com/SethSenpai/Tanuki) | pcb, case | 40%, underglow | <img src="https://github.com/SethSenpai/Tanuki/raw/master/Img/glamour1.jpg" width="200px"/> |
|
||||
| [Tg4x](https://github.com/MythosMann/tg4x) | pcb, case | pro micro, 40% | <img src="https://raw.githubusercontent.com/MythosMann/tg4x/master/pcb_raytrace.png" width="200px"/> |
|
||||
| [Ultimate Hacking Keyboard](https://github.com/UltimateHackingKeyboard/electronics) | pcb | split, display, 31FL3731 | <img src="https://ultimatehackingkeyboard.com/wordpress/wp-content/uploads/2018/07/uhk-split-palm-rest-1920.jpg" width="200px"/> |
|
||||
| [Voyager](https://github.com/ai03-2725/Voyager) | pcb | 60%, ansi, iso, rgb, led | <img src="https://raw.githubusercontent.com/ai03-2725/Voyager104/master/Renders/Front.png" width="200px"/> |
|
||||
| [Voyager65](https://github.com/ai03-2725/Voyager65) | pcb | 65%, usb-c, atxmega32a4u, rgb, underglow, switch-rgb-led, IS31FL3733 | <img src="https://raw.githubusercontent.com/ai03-2725/Voyager65/master/Renders/Back.png" width="200px"/> |
|
||||
| [XMMX TKL](https://geekhack.org/index.php?topic=93422.0) | pcb | | <img src="https://i.imgur.com/otn8LT3.jpg" width="200px"/> |
|
||||
|
||||
## Ortholinear-Keyboards
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | :---: | :---: |
|
||||
| [Alpsie](https://github.com/larrbo/odd-rocket/tree/master/alpsie) | pcb, case | 4x12, pro micro, alps, plate | <img src="https://3.bp.blogspot.com/-IAVUSnTmtZA/XArbAHFK5wI/AAAAAAAABeE/FKTl072R1CkIZwXr4AVCZ-_qG7uRjHw9wCLcBGAs/s640/IMG_20181128_194036.jpg" width="200px"/> |
|
||||
| [Chimera Ortho](https://github.com/GlenPickle/Chimera) | pcb | split, wireless | <img src="https://i.imgur.com/WqYzK5J.jpg" width="200px"/> |
|
||||
| [Contra](https://github.com/ai03-2725/Contra) | pcb | 4x12 | <img src="https://cartel.ltd/wp-content/uploads/bfi_thumb/contra_p02_02-nktu82ndud49t3w6hk7enn5y4vcjr4ouv2513udte4.jpg" width="200px" /> |
|
||||
| [Dactyl](https://github.com/adereth/dactyl-keyboard) | pcb, case | split, thumb keys, 5x6, 60%, 3d print | <img src="https://raw.githubusercontent.com/adereth/dactyl-cave/master/resources/glamourshot.png" width="200px"/> |
|
||||
| [Dactyl-ManuForm](https://github.com/tshort/dactyl-keyboard) | pcb, case | split, thumb keys, 4x5, 5x6, 40%, 60%, 3d print | <img src="https://camo.githubusercontent.com/a8dc88b0a973913a28a2373a7f3a9a3031af2672/687474703a2f2f692e696d6775722e636f6d2f4c646a456872522e6a7067" width="200px"/> |
|
||||
| [DIY Low-Profile Ortholinear](https://www.reddit.com/r/MechanicalKeyboards/comments/8sy17h/diy_low_profile_ortho/) ([PCB File](https://easyeda.com/7zark7/Kailh-Ortholinear)) | pcb | 14x6, low profile, teensy | <img src="https://i.imgur.com/cfNpqEE.jpg" width="200px" /> |
|
||||
| [DMOTE](https://github.com/veikman/dactyl-keyboard) | case | concave, thumb keys, split, alps, mx | <img src="https://camo.githubusercontent.com/85b0066d64467a10e0d0bcbdde26e6726eb95fde/687474703a2f2f76696b746f722e65696b6d616e2e73652f696d6167652f646d6f74652d322d746f702d646f776e2d766965772f646973706c6179" width="200px"/> |
|
||||
| [ErgoDox official](https://github.com/Ergodox-io) | pcb, acryl case, 3d printable case | split, thumb keys, 5x7, 3d print | <img src="https://github.com/Ergodox-io/ergodox-io/blob/master/src/img/ErgoDox-original-min.png" width="200px" /> |
|
||||
| [Ergo42](https://github.com/Biacco42/Ergo42) | pcb, case | split, 4x7 | <img src="https://raw.githubusercontent.com/Biacco42/Ergo42/readme/readme_image/ergo42_image.jpg" width="200px"/> |
|
||||
| [Gherkin](https://github.com/math0ne/keyboard-gherkin) | pcb | 30%, 3x10 | <img src="https://github.com/math0ne/keyboard-gherkin/raw/master/pcb/pcb-front.png" width="200px"/> |
|
||||
| [Helix](https://github.com/MakotoKurauchi/helix) | pcb, case | split, oled | <img src="https://camo.githubusercontent.com/348c95ff3baea20626e282b1a719eea49d0897b9/68747470733a2f2f692e696d6775722e636f6d2f5842416d796e4e2e6a7067" width="200px"/> |
|
||||
| [Koda](https://github.com/larrbo/odd-rocket/tree/master/koda) | pcb, case | 4x12, pro micro, kailh choc | <img src="https://4.bp.blogspot.com/-E9gGZbziicI/WwoNKDP-YPI/AAAAAAAABYk/IXV4gGrcQKo5Bqf7CRVpR_zYH2SCxAXwACLcBGAs/s400/IMG_20180522_231738.jpg" width="200px"/> |
|
||||
| [Lily58](https://github.com/kata0510/Lily58) | pcb, case | split, oled, 4x6 | <img src="https://user-images.githubusercontent.com/6285554/47264498-53384a80-d553-11e8-907a-a03c6f2c5893.JPG" width="200px"/> |
|
||||
| [Let's Split](https://github.com/climbalima/let-s-Split-v2) | pcb, [case](https://qmk.fm/keyboards/lets_split/) | split | <img src="https://camo.githubusercontent.com/dfbf83ee712079b862fccb951aefbb508b8a631d/687474703a2f2f692e696d6775722e636f6d2f797551754e4a552e6a7067" width="200px"/> |
|
||||
| [Manta 60](https://github.com/KamoNanban/Manta60) | pcb, case | 5x14, split, pro micro | <img src="https://pbs.twimg.com/media/Dy80wXGU0AAGZdK.jpg:large" width="200px" /> |
|
||||
| [Medusa](https://github.com/Gtrx0/Medusa) | pcb, case | 5x7, split, plate, bluetooth, nrf51822 | <img src="https://raw.githubusercontent.com/Gtrx0/Medusa/master/Renders/Front_Unpopulated.png?token=Anj1gDvVpb9Dt8Z8Zj3Az4azN7Fm_8hTks5bm9WJwA%3D%3D" width="200px" /> |
|
||||
| [Minisplit](https://github.com/kata0510/minisplit) | pcb, case | split, 4x6 | <img src="https://camo.githubusercontent.com/74766a3dbaf2b8a9ab8dae5c6cf656a7a0b9a9ac/68747470733a2f2f692e696d6775722e636f6d2f7a7767417251562e706e67" width="200px"/> |
|
||||
| [Plaid](https://github.com/hsgw/plaid) | pcb | 4x12, atmega328p | <img src="https://user-images.githubusercontent.com/2714926/49872071-481ae000-fe5b-11e8-963d-8aaa3a653e4d.jpg" width="200px"/> |
|
||||
| [Planck THK](https://github.com/olkb/planck_thk) | pcb, case | 4x12, rotary encoder | <img src="https://i.imgur.com/Jiy1jLN.jpg" width="200px"/> |
|
||||
| [QOL56](https://github.com/eswai/QOL56) | pcb, case | 4x14, pro micro, underglow, rgb | <img src="https://github.com/eswai/QOL56/raw/master/qol56-7.jpg" width="200px" /> |
|
||||
| [Science](https://github.com/peej/for-science-keyboard) | pcb | split, arduino, 5x5| <img src="https://camo.githubusercontent.com/fecf6f7bca9ec8b93e4031caa1ca3442cfb5a5f1/68747470733a2f2f692e696d6775722e636f6d2f666a6e546b42312e6a7067" width="200px"/> |
|
||||
| [SharkPCB](https://github.com/Gondolindrim/SharkPCB) | pcb, case | 4x12, rotary encoder, STM32, underglow, 3d print | <img src="https://github.com/Gondolindrim/SharkPCB/blob/master/renders/high/high1.png?raw=true" width="200px" /> |
|
||||
| [Split Infinitive](https://github.com/peej/for-split-keyboard/blob/master/README.md) | pcb | split, 5x6, pro micro | <img src="https://github.com/peej/for-split-keyboard/raw/master/pcb.png" width="200px"/> |
|
||||
| [Zen (RGBKB)](https://github.com/RGBKB/Keyboard-files/tree/master/Zen) [Build Guide](https://legonut.gitbooks.io/zen-keyboard/content/) | pcb, case | split, ergo, ortho, thumb keys, rgb led | <img src="https://camo.githubusercontent.com/6bf0257847f1e1972cfd6b9f289a6e8180163ff8/68747470733a2f2f692e696d6775722e636f6d2f7a337630416b732e6a7067" width="200px" /> |
|
||||
| []() | | | |
|
||||
|
||||
## Handwired
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | :---: | :---: |
|
||||
| [Arke](https://www.thingiverse.com/thing:2879329) | case | 3d print, split, pro micro | <img src="https://cdn.thingiverse.com/renders/42/c6/fc/55/83/38d59e181f2a3c892fe3f8365d00076e_preview_featured.jpg" width="200px" /> |
|
||||
| [Atreis](https://github.com/dekonnection/atreis) | case | handwiring | <img src="https://github.com/dekonnection/atreis/raw/master/pictures/GPI0El4.jpg" width="200px"/> |
|
||||
| [Atreus Split Keyboard](https://www.thingiverse.com/thing:1646718) | case | 3d print, split, pro micro | <img src="https://cdn.thingiverse.com/renders/2a/35/f6/bd/51/ee77cfa99ac6c721974f6eb92a52cce9_preview_featured.jpg" width="200px" /> |
|
||||
| [Ergo-Warped](https://github.com/pseudoku/ErgoWarp) | case | 3d print, split, ergo | <img src="https://raw.githubusercontent.com/pseudoku/Warped-keyboard/master/Photo/Proto6.jpg" width="200px" /> |
|
||||
| [Keyberon](https://github.com/TeXitoi/keyberon) | case, firmware | 3d print, handwiring, blue pill, ortholinear | <img src="https://raw.githubusercontent.com/TeXitoi/keyberon/master/images/keyberon.jpg" width="200px" /> |
|
||||
| [Mechanical Gamepad](https://www.thingiverse.com/thing:2593692) | case | 3d print, handwiring, pro micro, ortholinear | <img src="https://cdn.thingiverse.com/renders/61/74/20/bf/6f/387305d39edce0ec7409172e37eee126_preview_featured.jpg" width="200px" /> |
|
||||
| [Redox Manuform](https://www.thingiverse.com/thing:3503380) | case | 3d print, split, pro micro, underglow | <img src="https://cdn.thingiverse.com/renders/f5/89/b2/6b/a1/8d89de5ce484ac624324fb657f01e06e_preview_featured.jpg" width="200px" /> |
|
||||
| [SiCK-68](https://www.thingiverse.com/thing:3478494) | case | staggered, tkl, 3d print, handwiring, teensy | <img src="https://cdn.thingiverse.com/renders/b3/55/75/9b/d4/f20d6cca0ecda40347ad1802a63e518c_preview_featured.JPG" width="200px" /> |
|
||||
| [Tada68](https://www.thingiverse.com/thing:3372910) | case | 3d print, handwiring, teensy, tkl, staggered | <img src="https://cdn.thingiverse.com/renders/46/14/9d/aa/0e/8b1db0b24fc25d806e61f7b51671bd08_preview_featured.JPG" width="200px" /> |
|
||||
|
||||
## Numpad/Macropad
|
||||
| Name | Available Files | Tags | Image |
|
||||
| --- | --- | :---: | :---: |
|
||||
| [4x5-wireless-keypad-pcb](https://github.com/ogatatsu/4x5-wireless-keypad-pcb) | pcb | 4x5, bluetooth | <img src="https://github.com/ogatatsu/4x5-wireless-keypad-pcb/blob/master/images/1.png?raw=true" width="200px" /> |
|
||||
| [Amoeba Single-Switch PCB](https://github.com/mtl/keyboard-pcbs) | pcb | single-switch, handwiring | <img src="https://deskthority.net/resources/image/25215" width="200px"/> |
|
||||
| [Cherry-Mx-Bitboard-Re](https://github.com/ogatatsu/Cherry-Mx-Bitboard-Re) | pcb | single-switch, handwiring, hotswap | <img src="https://github.com/ogatatsu/Cherry-Mx-Bitboard-Re/raw/master/Images/a.jpeg" width="200px" /> |
|
||||
| [Cherry MX Keypad](http://syncchannel.blogspot.com/2016/06/cherry-mx-keypad.html?m=1) | pcb | 1x4, led | <img src="https://1.bp.blogspot.com/-Mur6fIsKDwU/V1NmGd7T4QI/AAAAAAAAAyU/Fh40F8Zl41YVosa03zkJl2WPSQ7sGS_AwCLcB/s280/CherryMXkeypad1.jpg" width="200px"/> |
|
||||
| [Cookpad Pad](https://github.com/cookpad/cookpad-pad) | pcb, case | 2x3, pro micro, ws2812b, underglow | <img src="https://github.com/cookpad/cookpad-pad/raw/master/docs/images/cookpad-pad.jpg" width="200px" /> |
|
||||
| [Game cart macropad](https://www.thingiverse.com/thing:3029578) | pcb, case | 4x4, 3d print | <img src="https://cdn.thingiverse.com/renders/f2/ab/f5/bd/7a/590674241125b3f375c064646978a1d0_preview_featured.jpg" width="200px"/> |
|
||||
| [GeekPad](https://git.bthlabs.pl/tomekwojcik/geekpad/) | pcb, case | 3x3, 3d print | <img src="https://i.imgur.com/FEzO81l.jpg" width="200px"/> |
|
||||
| [Hayabusa](https://github.com/ai03-2725/Hayabusa) | pcb | 5x5, rgb, ws2812b, pro micro | <img src="https://raw.githubusercontent.com/ai03-2725/Hayabusa/master/Renders/Front.png?rev=1.0" width="200px"/> |
|
||||
| [Kbord](https://github.com/dekuNukem/kbord) | pcb, case | 5x3, oled, rgb, sd-card | <img src="https://github.com/dekuNukem/kbord/raw/master/pics/title.jpg" width="200px"/> |
|
||||
| [LFK17](https://github.com/lfkeyboards/lfk17) | pcb | 5x4, numpad, hotswap, rgb | <img src="https://i.imgur.com/N4x5wXp.jpg" width="200px"/> |
|
||||
| [Lysergic 25](https://github.com/Gtrx0/lysergic25) | pcb, plate | 5x5, pro micro, plate, underglow, ws2812b, esd, usb-c | <img src="https://raw.githubusercontent.com/Gtrx0/lysergic25/master/Renders/Backside_populated.png" width="200px" /> |
|
||||
| [Meishi2](https://github.com/Biacco42/meishi2) | pcb | 1x4, pro micro | <img src="https://i.imgur.com/2SQqVlZ.png" width="200px"/> |
|
||||
| [SAMD21 Bridge Module Cherry Board](https://www.pcbway.com/project/shareproject/DIY_RGB_Cherry_MX_Hotkey_Board.html) | pcb, case | plate | <img src="https://file.pcbway.com/websponsor/18/07/26/195654072.jpg" width="200px" /> |
|
||||
| [Zesty 25](https://github.com/Gtrx0/zesty25) | pcb, case | 5x5, pro micro, plate, underglow, ws2812b | <img src="https://raw.githubusercontent.com/Gtrx0/zesty25/master/Renders/Backside_Unpopulated.png" width="200px" /> |
|
||||
|
||||
## Case
|
||||
| Name | Tags | Image |
|
||||
| --- | :---: | :---: |
|
||||
| [60% (Poker II, Pok3r) Keyboard Case 2.0](https://www.thingiverse.com/thing:983332) | 3d print | <img src="https://cdn.thingiverse.com/renders/8a/ac/f9/d8/ad/zanmYsB_-_Imgur_preview_featured.jpg" width="200px" /> |
|
||||
| [Arisu Keyboard Case](https://github.com/FateNozomi/arisu-case) | plate | <img src="https://camo.githubusercontent.com/52126fe22185eb48a922b8f7a2a2726cb2f19226/68747470733a2f2f692e696d6775722e636f6d2f6b6e74353138452e6a7067" width="200px" /> |
|
||||
| [Atreus62 High Profile Keyboard Case](https://www.thingiverse.com/thing:3246981) | 3d print | <img src="https://cdn.thingiverse.com/renders/e5/f1/48/84/33/5c363031158a92007b63b0468cea95c6_preview_featured.jpg" width="200px" /> |
|
||||
| [Chimera Egro 42 Tenting Case](https://github.com/wizarddata/Chimera-Egro-42-Case) | 3d print, tenting, split | |
|
||||
| [Cospad Case](https://www.thingiverse.com/thing:3233852) | 3d print, numpad | <img src="https://cdn.thingiverse.com/renders/23/ce/51/e6/60/c529ac4f1f85fb603e729532d6a4e3a5_preview_featured.jpg" width="200px" /> |
|
||||
| [Cospad Diamond Case](https://www.thingiverse.com/thing:3389713) | 3d print, numpad | <img src="https://cdn.thingiverse.com/renders/85/59/4f/c2/34/05af4ff61e5c7829934b3206dd96247e_preview_featured.jpg" width="200px" /> |
|
||||
| [Dactyl extended bottom case with gel wrist rests](https://www.thingiverse.com/thing:2436848) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/36/ef/6d/5f/59/c7a62cce09db90af7db2c013ccf94171_preview_featured.jpg" width="200px" /> |
|
||||
| [ErgoDash Tenting Case](https://github.com/wizarddata/Ergodash-Case) | 3d printing, split, tenting | |
|
||||
| [ErgoDox-Case](https://github.com/CharlesLenk/ErgoDox-Case) | split, thumb keys, 7x5 | |
|
||||
| [Ergodox Case](https://www.thingiverse.com/thing:753448) | 3d print | <img src="https://cdn.thingiverse.com/renders/4e/a2/85/36/dd/TopRightCase_preview_featured.jpg" width="200px" /> |
|
||||
| [Ergodox Case PrintDox](https://www.thingiverse.com/thing:2533064) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/cf/a4/a1/db/34/c62c3dfe57add30ddfdd10bba6959503_preview_featured.jpg" width="200px" /> |
|
||||
| [Fourier - Split 40% Keybaord](https://www.thingiverse.com/thing:3456985) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/95/4a/57/83/a5/c67e7861a9923e60be38f20b33bc8989_preview_featured.jpg" width="200px"/> |
|
||||
| [Iris Case](https://www.thingiverse.com/thing:3545130) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/c7/49/9a/e9/85/9781426efbd02367f1796f20f4918e63_preview_featured.jpg" width="200px" /> |
|
||||
| [Iris Case V2](https://www.thingiverse.com/thing:3186129) | 3d print, split | <img src="https://cdn.thingiverse.com/renders/ce/f1/6f/c4/1c/b10ee16c8aef868230d6b430237876b4_preview_featured.jpg" width="200px" /> |
|
||||
| [Iris Ice Project](https://github.com/rs/iris-ice) | 3d print, acrylic, white, led | <img src="https://github.com/rs/iris-ice/blob/master/img/iris-ice.jpg?raw=true" width="200px"/> |
|
||||
| [Iris Tenting Cases (High & Low Profile)](https://github.com/wizarddata/Iris-Case) | 3d print, tenting, split | |
|
||||
| [Let's Split Keyboard Angled Case](https://www.thingiverse.com/thing:2626039) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/e8/05/1a/03/99/429c22d5f6e9df54f0b98e73d0ec0a19_preview_featured.jpg" width="200px"/> |
|
||||
| [Let's Split Keyboard Case](https://www.thingiverse.com/thing:2482218) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/0f/cb/dc/ad/ac/f3ccdd27d2000e3f9255a7e3e2c48800_preview_featured.jpg" width="200px"/> |
|
||||
| [Let's Split Keyboard Plate & Case](https://www.thingiverse.com/thing:2335558) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/79/08/a0/f0/87/73727bf9538c5aa7b80ac16c14c6686b_preview_featured.jpg" width="200px" /> |
|
||||
| [Minidox Case](https://github.com/dotdash32/cases/tree/master/Minidox) | split, 3x6, vertically staggered, thumb keys | <img src="https://camo.githubusercontent.com/b345769866acbd0ad76c22250941aa4ab23667e5/68747470733a2f2f692e696d6775722e636f6d2f686d6e6b56646e2e6a7067" width="200px"/> |
|
||||
| [Minidox Tenting Case](https://github.com/wizarddata/Minidox-Cases) | 3d print, tenting, split | |
|
||||
| [Miuni32-Case](https://github.com/wizarddata/Miuni32-Case) | 3d print, ortholinear, 3x11 | <img src="https://preview.redd.it/da5ey5fxfyp21.jpg?width=960&crop=smart&auto=webp&s=470ec31cd4ad760dd30c16591740b238fa8a59cc" width=200px /> |
|
||||
| [Nyquist Plate + Case](https://www.thingiverse.com/thing:2389357) | 3d print, split, ortholinear | <img src="https://cdn.thingiverse.com/renders/81/82/66/eb/3d/7b3575db20022d9ffa547ea4deb728d1_preview_featured.jpg" width="200px" /> |
|
||||
| [OLKB (Planck, Preonic & Atomic)](https://github.com/olkb/olkb_parts) | 3d print, plate | |
|
||||
| [Redox-Case](https://github.com/Lenbok/scad-redox-case) | split, thumb keys, opensCad, 3d print | <img src="https://github.com/Lenbok/scad-redox-case/raw/master/images/redox-exploded.png" width="200px"/> |
|
||||
|
||||
8
docs/firmware.md
Normal file
8
docs/firmware.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Firmware
|
||||
|
||||
- [BlueMicro_BLE](https://github.com/jpconstantineau/BlueMicro_BLE) - A Bluetooth Firmware for the NRF52832
|
||||
- [Bluetosis](https://github.com/geoah/bluetosis) - Bluetooth firmware for the Mitosis keyboard
|
||||
- [Kaleidoscope](https://github.com/keyboardio/Kaleidoscope)
|
||||
- [Keyplus](https://github.com/ahtn/keyplus)
|
||||
- [QMK](https://github.com/qmk/qmk_firmware)
|
||||
- [TMK](https://github.com/tmk/tmk_keyboard)
|
||||
13
docs/miscellaneous.md
Normal file
13
docs/miscellaneous.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Miscellaneous
|
||||
- [BLE Micro Pro](https://github.com/sekigon-gonnoc/BLE-Micro-Pro) - Breakout board of BL654(nrf52840 module) which is almost compatible with Pro Micro. This board is designed for wireless split DIY keyboards.
|
||||
- [Cherry Popper](https://www.thingiverse.com/thing:2685653) - 3D printable Mechanical Keyboard Switch Opening Tool.
|
||||
- [Keyrigami](https://github.com/geckopfote/keyrigami) - Keycaps made from paper.
|
||||
- [Kailh-Low-Profile-Keycap](https://github.com/ogatatsu/Kailh-Low-Profile-Keycap) - Kailh Low Profile Keycap 3D files.
|
||||
- [KiCad Parts by Ai03](https://github.com/ai03-2725/MX_Alps_Hybrid.pretty) - KiCad Library of custom MX-Alps footprints.
|
||||
- [KiCad Parts by Daprice](https://github.com/daprice/keyswitches.pretty) - KiCAD footprint library for kailh choc and MX-style mechanical switches.
|
||||
- [KiCad Parts by Keebio](https://github.com/keebio/Keebio-Parts.pretty) - Various KiCAD footprints for mechanical keyboard parts.
|
||||
- [KiCAD Parts by TMK](https://github.com/tmk/keyboard_parts.pretty) - KiCad modules for keyboard design.
|
||||
- [Keyswitch Datasheets](https://github.com/keyboardio/keyswitch_documentation)
|
||||
- [List of split keyboards](https://docs.google.com/spreadsheets/d/19-rTWbp8SCKdZFByPZu3RT8NSF8vVddDe8WL6R6b1qQ/edit?usp=sharing)
|
||||
- QMK Proton C symbol/footprint for [KiCad](https://github.com/qmk/qmk_hardware/tree/master/kicad/proton_c), [Eagle](https://github.com/qmk/qmk_hardware/tree/master/eagle)
|
||||
- [XDA Keycap 3D Models](https://github.com/spooknik/XDA-Keycaps)
|
||||
14
docs/tools.md
Normal file
14
docs/tools.md
Normal file
@ -0,0 +1,14 @@
|
||||
# Tools
|
||||
- [ai03 Plate Generator](https://kbplate.ai03.me) - An advanced plate generator which doesn't result in 13.99999mm cutouts. [Github Repo](https://github.com/ai03-2725/another-keyboard-builder)
|
||||
- [Kalerator](https://kalerator.clueboard.co) - Pcb generator for keyboard-layout-editor generated layouts. [GitHub Site](https://github.com/skullydazed/kalerator), [Eagle Parts Library](https://github.com/skullydazed/clueboard_eagle)
|
||||
- [kbpcb](http://kbpcb.mrkeebs.com/) - Create KiCad PCB files from [KLE](http://www.keyboard-layout-editor.com) json files [Github page](https://github.com/fcoury/kbpcb)
|
||||
- [Keyboard Firmware Builder](https://kbfirmware.com) - Online QMK Firmware Builder (2+ years behind QMK firmware master)
|
||||
- [keyboard-layout-editor](http://www.keyboard-layout-editor.com/) - Is a web application that enables the editing of keyboard-layouts, i.e., the position and appearance of each physical key. [GitHub Site](https://github.com/ijprest/keyboard-layout-editor)
|
||||
- [Keyboard Layout 3D Viewer](https://github.com/eswai/KL3V) - 3D render keyboard-layout-editor.com layouts
|
||||
- [kle_render](https://github.com/CQCumbers/kle_render) - Get prettier images of Keyboard Layout Editor designs
|
||||
- [Parametric Mechanical Keycap Library](https://github.com/rsheldiii/KeyV2) - Is a keycap and keyset construction library for mechanical keyboards, written in openSCAD.
|
||||
- [Plate & Case Builder](http://builder.swillkb.com) - Keyboard top plate CAD files generator, for keyboard-layout-editor generated layouts
|
||||
- [Q2K](https://github.com/2hwk/Q2K) - A python based utility for parsing QMK Firmware keymaps to various outputs
|
||||
- [QMK Configurator](https://config.qmk.fm/) - An open source configurator for QMK Firmware
|
||||
- [TMK Firmware Builder](http://kb.sized.io) - Online TMK Firmware Builder
|
||||
- [kbd-prettier](https://github.com/blakedietz/kbd-prettier) - Automatically format your keyboard layout
|
||||
8
docs/tutorials.md
Normal file
8
docs/tutorials.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Tutorials
|
||||
- [A modern handwiring guide](https://geekhack.org/index.php?topic=87689.0)
|
||||
- [Hand wiring a let's split](https://johannes-jansson.github.io/projects/2018/07/23/hand-wiring-lets-split.html) (pro micro)
|
||||
- [How to integrate a trackpoint in a mechanical keyboard (TMK, Teensy)](https://github.com/alonswartz/trackpoint)
|
||||
- [Keyboard PCB Guide](https://github.com/ruiqimao/keyboard-pcb-guide/blob/master/README.md)
|
||||
- [lets-split-guide](https://github.com/nicinabox/lets-split-guide) - This guide covers building a Let's Split v2.
|
||||
- [The Keyboard Matrix ](http://blog.komar.be/how-to-make-a-keyboard-the-matrix/) - How a keyboard matrix work, explained in depth.
|
||||
- [The Keyboard Matrix 2](https://www.dribin.org/dave/keyboard/one_html/) - Another explanation how a keyboard matrix work and why it needs diodes.
|
||||
13
gridsome.client.js
Normal file
13
gridsome.client.js
Normal file
@ -0,0 +1,13 @@
|
||||
import { config, library } from '@fortawesome/fontawesome-svg-core'
|
||||
import { faGithub } from '@fortawesome/free-brands-svg-icons'
|
||||
import { faKeyboard } from '@fortawesome/free-solid-svg-icons'
|
||||
import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome'
|
||||
import '@fortawesome/fontawesome-svg-core/styles.css'
|
||||
|
||||
// Make sure you tell Font Awesome to skip auto-inserting CSS into the <head>
|
||||
config.autoAddCss = false;
|
||||
library.add(faGithub, faKeyboard)
|
||||
|
||||
export default function (Vue) {
|
||||
Vue.component('font-awesome', FontAwesomeIcon)
|
||||
}
|
||||
49
gridsome.config.js
Executable file
49
gridsome.config.js
Executable file
@ -0,0 +1,49 @@
|
||||
// This is where project configuration and plugin options are located.
|
||||
// Learn more: https://gridsome.org/docs/config
|
||||
|
||||
// Changes here require a server restart.
|
||||
// To restart press CTRL + C in terminal and run `gridsome develop`
|
||||
|
||||
|
||||
module.exports = {
|
||||
siteName: 'Keebfol.io',
|
||||
siteDescription: 'Curated list of mechanical keyboard resources.',
|
||||
siteUrl: 'https://keebfol.io',
|
||||
chainWebpack(config) {
|
||||
config.mode('development')
|
||||
const svgRule = config.module.rule('svg')
|
||||
svgRule.uses.clear()
|
||||
svgRule
|
||||
.use('vue-svg-loader')
|
||||
.loader('vue-svg-loader')
|
||||
},
|
||||
plugins: [
|
||||
{
|
||||
use: 'gridsome-plugin-tailwindcss'
|
||||
},
|
||||
{
|
||||
use: '@gridsome/source-filesystem',
|
||||
options: {
|
||||
index: ['README'],
|
||||
path: '**/*.md',
|
||||
baseDir: './docs',
|
||||
typeName: 'DocPage',
|
||||
remark: {
|
||||
autolinkHeadings: {
|
||||
content: {
|
||||
type: 'text',
|
||||
value: '#'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
transformers: {
|
||||
remark: {
|
||||
externalLinksTarget: '_blank',
|
||||
externalLinksRel: ['nofollow', 'noopener', 'noreferrer'],
|
||||
anchorClassName: 'icon icon-link',
|
||||
}
|
||||
}
|
||||
}
|
||||
38
gridsome.server.js
Executable file
38
gridsome.server.js
Executable file
@ -0,0 +1,38 @@
|
||||
// Server API makes it possible to hook into various parts of Gridsome
|
||||
// on server-side and add custom data to the GraphQL data layer.
|
||||
// Learn more: https://gridsome.org/docs/server-api
|
||||
|
||||
// Changes here require a server restart.
|
||||
// To restart press CTRL + C in terminal and run `gridsome develop`
|
||||
|
||||
// const axios = require('axios')
|
||||
|
||||
module.exports = function (api) {
|
||||
api.loadSource(async store => {
|
||||
// const { data } = await axios.get('https://benroe.github.io/switch-database/mechanical-keyboard-switches.json')
|
||||
|
||||
// const contentType = store.addContentType({
|
||||
// typeName: 'Switches',
|
||||
// route: '/switch/:id'
|
||||
// })
|
||||
|
||||
// for (const item of data) {
|
||||
// contentType.addNode({
|
||||
// id: item.id,
|
||||
// brand: item.brand,
|
||||
// type: item.type,
|
||||
// path: '/switch/' + item.id
|
||||
// })
|
||||
// }
|
||||
|
||||
// contentType.addNode({
|
||||
// fields: {
|
||||
// items: data.map(item => {
|
||||
// // Reference a node with typeName 'Item'
|
||||
// return store.createReference('Item', item.id)
|
||||
// })
|
||||
// }
|
||||
// })
|
||||
|
||||
})
|
||||
}
|
||||
11675
package-lock.json
generated
Executable file
11675
package-lock.json
generated
Executable file
File diff suppressed because it is too large
Load Diff
25
package.json
Executable file
25
package.json
Executable file
@ -0,0 +1,25 @@
|
||||
{
|
||||
"name": "andremadarang",
|
||||
"private": false,
|
||||
"scripts": {
|
||||
"build": "gridsome build",
|
||||
"develop": "gridsome develop",
|
||||
"explore": "gridsome explore"
|
||||
},
|
||||
"dependencies": {
|
||||
"@fortawesome/fontawesome-svg-core": "^1.2.19",
|
||||
"@fortawesome/free-brands-svg-icons": "^5.9.0",
|
||||
"@fortawesome/free-solid-svg-icons": "^5.9.0",
|
||||
"@fortawesome/vue-fontawesome": "^0.1.6",
|
||||
"axios": "^0.19.0",
|
||||
"gridsome": "^0.6.3",
|
||||
"vue-good-table": "^2.16.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"vue-svg-loader": "^0.12.0",
|
||||
"gridsome-plugin-tailwindcss": "^2.2.15",
|
||||
"@gridsome/source-filesystem": "^0.5.0",
|
||||
"@gridsome/transformer-csv": "^0.2.1",
|
||||
"@gridsome/transformer-remark": "^0.3.2"
|
||||
}
|
||||
}
|
||||
50
src/assets/css/tailwind.css
Normal file
50
src/assets/css/tailwind.css
Normal file
@ -0,0 +1,50 @@
|
||||
@tailwind base;
|
||||
|
||||
body {
|
||||
@apply text-primary-dark;
|
||||
}
|
||||
.active--exact {
|
||||
@apply font-bold;
|
||||
@apply text-primary;
|
||||
}
|
||||
a:hover{
|
||||
@apply text-primary;
|
||||
}
|
||||
h1 {
|
||||
@apply text-3xl;
|
||||
@apply font-bold;
|
||||
@apply mb-4;
|
||||
}
|
||||
|
||||
h2 {
|
||||
@apply text-2xl;
|
||||
@apply font-bold;
|
||||
@apply mt-8;
|
||||
}
|
||||
|
||||
h3 {
|
||||
@apply text-xl;
|
||||
@apply mt-4;
|
||||
}
|
||||
tr {
|
||||
@apply border-b;
|
||||
}
|
||||
td {
|
||||
@apply py-2;
|
||||
}
|
||||
.content {
|
||||
@apply leading-loose;
|
||||
}
|
||||
.content a {
|
||||
@apply border-b-2;
|
||||
}
|
||||
.content a:hover {
|
||||
@apply border-primary;
|
||||
}
|
||||
.content ul {
|
||||
@apply ml-5;
|
||||
@apply list-disc;
|
||||
}
|
||||
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
4
src/components/README.md
Executable file
4
src/components/README.md
Executable file
@ -0,0 +1,4 @@
|
||||
Add components that will be imported to Pages and Layouts to this folder.
|
||||
Learn more about components here: https://gridsome.org/docs/components
|
||||
|
||||
You can delete this file.
|
||||
12
src/data/doc-links.yaml
Normal file
12
src/data/doc-links.yaml
Normal file
@ -0,0 +1,12 @@
|
||||
- title: Section 1
|
||||
items:
|
||||
- title: Keyboards
|
||||
link: /
|
||||
- title: Firmware
|
||||
link: /firmware
|
||||
- title: Tools
|
||||
link: /tools
|
||||
- title: Tutorials
|
||||
link: /tutorials
|
||||
- title: Miscellaneous
|
||||
link: /miscellaneous
|
||||
BIN
src/favicon.png
Executable file
BIN
src/favicon.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
34
src/layouts/Default.vue
Executable file
34
src/layouts/Default.vue
Executable file
@ -0,0 +1,34 @@
|
||||
<template>
|
||||
<div
|
||||
class="content-wrapper"
|
||||
>
|
||||
<Header />
|
||||
|
||||
<div class="container w-full flex flex-wrap mx-auto px-4">
|
||||
<slot/>
|
||||
</div>
|
||||
|
||||
<!-- <Footer /> -->
|
||||
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<static-query>
|
||||
query {
|
||||
metaData {
|
||||
siteName
|
||||
}
|
||||
}
|
||||
</static-query>
|
||||
|
||||
<script>
|
||||
import Header from './partials/Header'
|
||||
// import Footer from './partials/Footer'
|
||||
|
||||
export default {
|
||||
components: {
|
||||
Header,
|
||||
// Footer,
|
||||
}
|
||||
};
|
||||
</script>
|
||||
136
src/layouts/Docs.vue
Normal file
136
src/layouts/Docs.vue
Normal file
@ -0,0 +1,136 @@
|
||||
<template>
|
||||
<Layout>
|
||||
<!-- Sidebar Nav -->
|
||||
<div v-if="links" class="w-full lg:w-1/5 p-6 pl-0 text-gray-800 leading-normal">
|
||||
<template v-for="(group, i1) in links">
|
||||
<!-- Section headline not needed -->
|
||||
<!-- <p class="font-bold py-2 lg:pb-6 text-gray-700"
|
||||
:key="`title-${i1}`">
|
||||
{{ group.title }}
|
||||
</p> -->
|
||||
<!-- Fake dropdown field as menu toggle for mobile view -->
|
||||
<div class="block lg:hidden sticky inset-0">
|
||||
<button id="side-nav-toggle"
|
||||
class="flex w-full justify-end px-3 py-3 bg-white lg:bg-transparent border rounded border-gray-500 hover:border-primary appearance-none focus:outline-none">
|
||||
<svg class="fill-current h-3 float-right"
|
||||
viewBox="0 0 20 20"
|
||||
xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M9.293 12.95l.707.707L15.657 8l-1.414-1.414L10 10.828 5.757 6.586 4.343 8z"/>
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
<div id="menu-content"
|
||||
class="w-full sticky inset-0 h-64 lg:h-auto overflow-x-hidden overflow-y-auto lg:overflow-y-hidden lg:block mt-0 border border-gray-400 rounded-b lg:border-transparent bg-white shadow lg:shadow-none lg:bg-transparent z-20"
|
||||
:class="{hidden: !showDropdownMenu}">
|
||||
<ul class="list-reset ml-2 lg:ml-0">
|
||||
<li v-for="(item, i2) in group.items"
|
||||
class="">
|
||||
<g-link :to="item.link" :key="`link-${i1}-${i2}`"
|
||||
class="block my-2 pl-0 align-middle border-transparent lg:border-secondary lg:hover:border-secondary-light">
|
||||
{{ item.title }}
|
||||
</g-link>
|
||||
<!-- Submenu -->
|
||||
<ul v-if="item.link === currentPath && subtitles && subtitles.length" :key="`submenu-${i1}-${i2}`"
|
||||
class="ml-0">
|
||||
<li v-for="subtitle in subtitles"
|
||||
class="block py-2 pl-4 align-middle hover:text-primary-dark border-transparent lg:border-l-4 lg:border-primary lg:hover:border-secondary">
|
||||
<g-link :to="item.link + subtitle.anchor"
|
||||
class="hover:text-primary">
|
||||
{{ subtitle.value }}
|
||||
</g-link>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- /Submenu -->
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</template>
|
||||
</div>
|
||||
<!-- /Sidebar Nav -->
|
||||
<!-- Content -->
|
||||
<div class="w-full lg:w-4/5 lg:p-8 lg:mt-0 leading-normal bg-white lg:border-l border-gray-300">
|
||||
<slot />
|
||||
<hr class="mt-10 border-b border-gray-400">
|
||||
<p>
|
||||
<a :href="editLink" target="_blank">
|
||||
<font-awesome :icon="['fab', 'github']" class="mr-1"/>
|
||||
<span>Edit this page on GitHub</span>
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<!-- /Content -->
|
||||
<!--Back link -->
|
||||
<div class="w-full lg:w-4/5 lg:ml-auto text-base">
|
||||
<nav class="flex">
|
||||
<div class="flex-grow text-left pl-10 py-6">
|
||||
<g-link v-if="previousPage" :to="previousPage.link"
|
||||
class="text-base md:text-sm font-bold text-gray-400">
|
||||
<span class="text-base font-bold"><</span>
|
||||
{{ previousPage.title }}
|
||||
</g-link>
|
||||
</div>
|
||||
<div class="flex-grow text-right pr-8 py-6">
|
||||
<g-link v-if="nextPage" :to="nextPage.link"
|
||||
class="text-base md:text-sm font-bold text-gray-400">
|
||||
{{ nextPage.title }}
|
||||
<span class="text-base font-bold">></span>
|
||||
</g-link>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
</Layout>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
data () {
|
||||
return {
|
||||
showDropdownMenu: false
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
},
|
||||
mounted: function () {
|
||||
const that = this
|
||||
|
||||
// Attach event listener to the root vue element
|
||||
this.$el.addEventListener('click', function (ev) {
|
||||
if (ev.target.id === 'side-nav-toggle') {
|
||||
// click on the sidebar menu fake dropdown in mobile view
|
||||
that.showDropdownMenu = !that.showDropdownMenutrue
|
||||
|
||||
} else {
|
||||
// click not on the sidebar menu fake dropdown in mobile view
|
||||
that.showDropdownMenu = false
|
||||
}
|
||||
})
|
||||
},
|
||||
props: {
|
||||
subtitles: Array,
|
||||
links: Array
|
||||
},
|
||||
computed: {
|
||||
currentPath () {
|
||||
return this.$route.path
|
||||
},
|
||||
editLink () {
|
||||
let path = this.currentPath
|
||||
if((path.match(new RegExp("/", "g")) || []).length == 1) path = path + '/README'
|
||||
return `https://github.com/BenRoe/awesome-mechanical-keyboard/blob/master${path}.md`
|
||||
},
|
||||
items () {
|
||||
return this.links.reduce((acc, group) => (acc.push(...group.items), acc), [])
|
||||
},
|
||||
currentIndex () {
|
||||
return this.items.findIndex(item => item.link === this.$route.path)
|
||||
},
|
||||
nextPage () {
|
||||
return this.items[this.currentIndex + 1]
|
||||
},
|
||||
previousPage () {
|
||||
return this.items[this.currentIndex - 1]
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
5
src/layouts/README.md
Executable file
5
src/layouts/README.md
Executable file
@ -0,0 +1,5 @@
|
||||
Layout components are used to wrap pages and templates. Layouts should contain components like headers, footers or sidebars that will be used across the site.
|
||||
|
||||
Learn more about Layouts: https://gridsome.org/docs/layouts
|
||||
|
||||
You can delete this file.
|
||||
39
src/layouts/partials/Footer.vue
Normal file
39
src/layouts/partials/Footer.vue
Normal file
@ -0,0 +1,39 @@
|
||||
<template>
|
||||
<footer class="bg-white border-t border-gray-400 shadow">
|
||||
<div class="container mx-auto flex py-8">
|
||||
<div class="w-full mx-auto flex flex-wrap">
|
||||
<div class="flex w-full lg:w-1/2 ">
|
||||
<div class="px-8">
|
||||
<h3 class="font-bold text-gray-900">About</h3>
|
||||
<p class="py-4 text-gray-600 text-sm">
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas vel mi ut felis tempus commodo nec id erat. Suspendisse consectetur dapibus velit ut lacinia.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="flex w-full lg:w-1/2 lg:justify-end lg:text-right">
|
||||
<div class="px-8">
|
||||
<h3 class="font-bold text-gray-900">Social</h3>
|
||||
<ul class="list-reset items-center text-sm pt-3">
|
||||
<li>
|
||||
<a class="inline-block text-gray-600 no-underline hover:text-gray-900 hover:underline py-1" href="#">Add social links</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</template>
|
||||
|
||||
<static-query>
|
||||
</static-query>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
components: {
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<style>
|
||||
</style>
|
||||
89
src/layouts/partials/Header.vue
Normal file
89
src/layouts/partials/Header.vue
Normal file
@ -0,0 +1,89 @@
|
||||
<template>
|
||||
<header class="bg-white">
|
||||
<nav id="header" class="w-full z-10 top-0 bg-white border-b border-gray-300">
|
||||
<div class="w-full container mx-auto flex flex-wrap items-center justify-between mt-0 py-4">
|
||||
<div class="pl-4 flex items-center">
|
||||
<g-link to="/">
|
||||
<font-awesome :icon="['fas', 'keyboard']"
|
||||
class="mr-2 text-primary-light hover:text-primary"
|
||||
size="2x">
|
||||
</font-awesome>
|
||||
</g-link>
|
||||
<g-link to="/" class="text-secondary group-hover:text-secondary-dark text-base no-underline hover:no-underline font-extrabold text-xl">
|
||||
Keebfol.io
|
||||
</g-link>
|
||||
</div>
|
||||
<!-- Mobile Menu Button -->
|
||||
<div class="block lg:hidden pr-4">
|
||||
<button id="main-nav-toggle"
|
||||
class="flex items-center px-3 py-2 border rounded text-gray-500 border-gray-500 hover:text-primary hover:border-primary appearance-none focus:outline-none">
|
||||
<svg class="fill-current h-3 w-3"
|
||||
viewBox="0 0 20 20"
|
||||
xmlns="http://www.w3.org/2000/svg">
|
||||
<title>Menu</title>
|
||||
<path d="M0 3h20v2H0V3zm0 6h20v2H0V9zm0 6h20v2H0v-2z"/>
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
<!-- /Mobile Menu Button -->
|
||||
<div id="nav-content"
|
||||
class="w-full flex-grow lg:flex lg:content-center lg:items-center lg:w-auto lg:block mt-2 lg:mt-0 z-20"
|
||||
:class="{hidden: !showMobileMenu}">
|
||||
<div class="flex-1 w-full mx-auto max-w-sm content-center py-4 lg:py-0">
|
||||
<div class="relative pull-right pl-4 pr-4 md:pr-0">
|
||||
<!-- <input type="search" placeholder="Search" class="w-full bg-gray-100 text-sm text-gray-800 transition border focus:outline-none focus:border-purple-500 rounded py-1 px-2 pl-10 appearance-none leading-normal">
|
||||
<div class="absolute search-icon" style="top: 0.375rem;left: 1.75rem;">
|
||||
<svg class="fill-current pointer-events-none text-gray-800 w-4 h-4" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20">
|
||||
<path d="M12.9 14.32a8 8 0 1 1 1.41-1.41l5.35 5.33-1.42 1.42-5.33-5.34zM8 14A6 6 0 1 0 8 2a6 6 0 0 0 0 12z"></path>
|
||||
</svg>
|
||||
</div> -->
|
||||
</div>
|
||||
</div>
|
||||
<ul class="list-reset lg:flex justify-end items-center">
|
||||
<li class="mr-3 py-2 lg:py-0">
|
||||
<g-link to="/" class="inline-block py-2 px-4">Open Source Projects</g-link>
|
||||
</li>
|
||||
<li class="mr-3 py-2 lg:py-0">
|
||||
<g-link to="/switch-database" class="inline-block py-2 px-4">Switch Database</g-link>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
</template>
|
||||
|
||||
<static-query>
|
||||
</static-query>
|
||||
|
||||
<script>
|
||||
// import SearchInput from "../../components/SearchInput";
|
||||
|
||||
export default {
|
||||
components: {
|
||||
// SearchInput
|
||||
},
|
||||
data() {
|
||||
return {
|
||||
showMobileMenu: false,
|
||||
theme: ""
|
||||
};
|
||||
},
|
||||
methods: {
|
||||
},
|
||||
mounted: function () {
|
||||
const that = this
|
||||
|
||||
// Attach event listener to the root vue element
|
||||
this.$el.addEventListener('click', function (ev) {
|
||||
if (ev.target.id === 'main-nav-toggle') {
|
||||
// clicked on the nav button in mobile view
|
||||
that.showMobileMenu = !that.showMobileMenu
|
||||
} else {
|
||||
// click somewhere else, not on the nav button
|
||||
that.showMobileMenu = false
|
||||
}
|
||||
})
|
||||
},
|
||||
};
|
||||
</script>
|
||||
16
src/main.js
Executable file
16
src/main.js
Executable file
@ -0,0 +1,16 @@
|
||||
// This is the main.js file. Import global CSS and scripts here.
|
||||
// The Client API can be used here. Learn more: gridsome.org/docs/client-api
|
||||
|
||||
// Add global components
|
||||
import './assets/css/tailwind.css'
|
||||
import DefaultLayout from '~/layouts/Default.vue'
|
||||
import DocsLayout from '~/layouts/Docs.vue'
|
||||
|
||||
export default function (Vue, { router, head, isClient }) {
|
||||
// Set default layout as a global component
|
||||
Vue.component('Layout', DefaultLayout)
|
||||
Vue.component('DocsLayout', DocsLayout)
|
||||
// router.options.linkActiveClass = 'is-active'
|
||||
}
|
||||
|
||||
|
||||
18
src/pages/404.vue
Executable file
18
src/pages/404.vue
Executable file
@ -0,0 +1,18 @@
|
||||
<template>
|
||||
<Layout>
|
||||
<div class="container-inner mx-auto text-center py-16">
|
||||
<g-image class="mx-auto lg:w-3/4" src="../../static/404.svg" />
|
||||
<h2 class="text-4xl font-bold">Page Not Found</h2>
|
||||
</div>
|
||||
|
||||
</Layout>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
metaInfo: {
|
||||
title: 'Page Not Found'
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
5
src/pages/README.md
Executable file
5
src/pages/README.md
Executable file
@ -0,0 +1,5 @@
|
||||
Pages are usually used for normal pages or for listing items from a GraphQL collection.
|
||||
Add .vue files here to create pages. For example **About.vue** will be **site.com/about**.
|
||||
Learn more about pages: https://gridsome.org/docs/pages
|
||||
|
||||
You can delete this file.
|
||||
54
src/pages/switch-database.vue
Executable file
54
src/pages/switch-database.vue
Executable file
@ -0,0 +1,54 @@
|
||||
<template>
|
||||
<Layout>
|
||||
<div class="container-inner mx-auto py-16">
|
||||
<h2 class="text-4xl font-bold mb-16">Mechanical Keyboard Switch Database</h2>
|
||||
<div>
|
||||
<vue-good-table
|
||||
:columns="columns"
|
||||
:rows="switches"/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</Layout>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
import 'vue-good-table/dist/vue-good-table.css'
|
||||
import { VueGoodTable } from 'vue-good-table';
|
||||
|
||||
const axios = require('axios');
|
||||
|
||||
export default {
|
||||
metaInfo: {
|
||||
title: 'Mechanical Keyboard Switch Database'
|
||||
},
|
||||
components: {
|
||||
VueGoodTable,
|
||||
},
|
||||
data(){
|
||||
return {
|
||||
switches: null,
|
||||
columns: [
|
||||
{
|
||||
label: 'Id',
|
||||
field: 'id',
|
||||
},
|
||||
{
|
||||
label: 'Marke',
|
||||
field: 'brand',
|
||||
},
|
||||
{
|
||||
label: 'Type',
|
||||
field: 'type',
|
||||
},
|
||||
],
|
||||
};
|
||||
},
|
||||
mounted: function () {
|
||||
axios
|
||||
.get('https://benroe.github.io/switch-database/mechanical-keyboard-switches.json')
|
||||
.then(response => (this.switches = response.data))
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
41
src/templates/DocPage.vue
Normal file
41
src/templates/DocPage.vue
Normal file
@ -0,0 +1,41 @@
|
||||
<template>
|
||||
<DocsLayout :subtitles="$page.doc.subtitles" :links="links">
|
||||
<div class="md content" v-html="$page.doc.content"></div>
|
||||
</DocsLayout>
|
||||
</template>
|
||||
|
||||
<page-query>
|
||||
query DocPage ($path: String!) {
|
||||
doc: docPage (path: $path) {
|
||||
path
|
||||
title
|
||||
content
|
||||
headings (depth: h1) {
|
||||
value
|
||||
}
|
||||
subtitles: headings (depth: h2) {
|
||||
value
|
||||
anchor
|
||||
}
|
||||
}
|
||||
}
|
||||
</page-query>
|
||||
|
||||
<script>
|
||||
import links from '@/data/doc-links.yaml'
|
||||
|
||||
export default {
|
||||
computed: {
|
||||
links () {
|
||||
return links
|
||||
}
|
||||
},
|
||||
metaInfo () {
|
||||
const { title, headings } = this.$page.doc
|
||||
|
||||
return {
|
||||
title: title || (headings.length ? headings[0].value : undefined)
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
7
src/templates/README.md
Executable file
7
src/templates/README.md
Executable file
@ -0,0 +1,7 @@
|
||||
Templates for **GraphQL collections** should be added here.
|
||||
To create a template for a collection called `WordPressPost`
|
||||
create a file named `WordPressPost.vue` in this folder.
|
||||
|
||||
Learn more: https://gridsome.org/docs/templates
|
||||
|
||||
You can delete this file.
|
||||
1
static/404.svg
Executable file
1
static/404.svg
Executable file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 15 KiB |
3
static/README.md
Executable file
3
static/README.md
Executable file
@ -0,0 +1,3 @@
|
||||
Add static files here. Files in this directory will be copied directly to `dist` folder during build. For example, /static/robots.txt will be located at https://yoursite.com/robots.txt.
|
||||
|
||||
This file should be deleted.
|
||||
29
tailwind.config.js
Executable file
29
tailwind.config.js
Executable file
@ -0,0 +1,29 @@
|
||||
module.exports = {
|
||||
theme: {
|
||||
extend: {
|
||||
colors: {
|
||||
'primary': {
|
||||
light: '#4ECDC4',
|
||||
default: '#00B5A8',
|
||||
dark: '#0B4C51',
|
||||
},
|
||||
'secondary': {
|
||||
light: '#FF8C8C',
|
||||
default: '#FF6B6B',
|
||||
dark: '#DD3939',
|
||||
},
|
||||
},
|
||||
'highlight': {
|
||||
light: '#FFED96',
|
||||
default: '#FFE66D',
|
||||
dark: '#D6B513',
|
||||
},
|
||||
},
|
||||
},
|
||||
variants: {
|
||||
// Some useful comment
|
||||
},
|
||||
plugins: [
|
||||
// Some useful comment
|
||||
]
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user