Skip to content

Commit

Permalink
homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
bstiq committed Oct 25, 2023
1 parent 9751f37 commit 948a1a5
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,52 @@ nav_order: 1
permalink: /
---


# Table of contents

1. TOC
{:toc}

# Introduction

Welcome to the official Bastard Keyboards documentation website.

Just like the rest of BK's work, this wiki is open-source - with the files on github. This wiki is hosted by Github Pages.

# What you will find here

**Use the left menu to navigate. You will find:**
- build guides for all keyboards*
- detailed troubleshooting tips to help you debug your build
- answers to frequently asked questions
- recommendations for 3d printing your own model

*If you are building the TBK Mini, use the Skeletyl build guide. If you are building a Charybdis Mini, use the Charybdis Nano build guide.

Check warning on line 28 in index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Skeletyl)

**Additionally, we have a youtube channel.**
On it, you will find:
- video build guides for the keyboards
- tips and advice on designing your own case
- explanations on how to use your keyboard
- build logs and progress VLogs

Bastard Keyboards on youtube: [youtube.com/@bastardkb][youtube]

# Quick Links

- Bastard Keyboards on GitHub: [github.com/bastardkb][github]
- Bastard Keyboards website: [bastardkb.com][website]
- Bastard Keyboards discord: [bstkbd.com/discord][discord]
- Bastard Keyboards youtube: [youtube.com/@bastardkb][youtube]

# How to get help

If you are unable to solve your issue, you may get additional help of the Bastard Keyboards Discord server: [bstkbd.com/discord][discord]


----

[discord]: https://www.bstkbd.com/discord
[github]: https://github.com/bastardkb
[website]: https://bastardkb.com
[youtube]: https://youtube.com/@bastardkb

0 comments on commit 948a1a5

Please sign in to comment.