Skip to content

Commit

Permalink
Fix navigation and update config
Browse files Browse the repository at this point in the history
  • Loading branch information
0xcharly committed Oct 17, 2023
1 parent b9b4eb5 commit ad8f2a8
Show file tree
Hide file tree
Showing 7 changed files with 74 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/Gemfile
/Gemfile.lock
/_site/
36 changes: 36 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
title: Bastard Keyboards Documentation
description: A compilation of all Bastard Keyboards documentations.
theme: just-the-docs

markdown: kramdown

remote_theme: pmarsceill/just-the-docs

exclude:
- .jekyll-cache
- gemfiles/
- Gemfile
- Gemfile.lock
- _site/

plugins:
- jekyll-default-layout

# Aux links for the upper right navigation
aux_links:
"Bastard Keyboards on GitHub":
- "https://github.com/bastardkb"

# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: true

# Sort order for navigation links
# nav_sort: case_insensitive # default, equivalent to nil
nav_sort: case_sensitive # Capital letters sorted before lowercase

# External navigation links
nav_external_links:
- title: Bastard Keyboards on GitHub
url: https://github.com/bastardkb

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
10 changes: 10 additions & 0 deletions fw/charybdis-keymap.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
layout: default
title: Charybdis Keymap
nav_order: 1
parent: Firmware
---

1. TOC
{:toc}

All the features listed below are available in the Charybdis stock keymaps (built from the `via` keymap source).

The stock keymap aims at providing a consistent experience out of the box. Because some features can be mutually exclusives (e.g. [Auto sniping on layer](#auto-sniping-on-layer) and [Auto pointer layer](#auto-pointer-layer)), not all features are enabled by default. It may be necessary to rebuild the firmware to enable or disable some of the features listed below.
Expand Down
8 changes: 5 additions & 3 deletions fw/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
layout: default
title: Getting Started
nav_order: 1
title: Firmware
nav_order: 3
has_children: true
---

* TOC {:toc}
1. TOC
{:toc}
8 changes: 5 additions & 3 deletions hw/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
layout: default
title: Getting Started
nav_order: 1
title: Hardware
nav_order: 2
has_children: true
---

* TOC {:toc}
1. TOC
{:toc}
10 changes: 10 additions & 0 deletions hw/rp2040-community.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
layout: default
title: RP2040 Controllers
nav_order: 1
parent: Hardware
---

1. TOC
{:toc}

## BKB standard

The "BKB standard" is a standard pinout that was defined by a committee of designers on the BastardKB Discord server when the first RP2040 were created in 2022.
Expand Down
7 changes: 5 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
layout: default
title: Getting Started
title: Home
nav_order: 1
has_children: true
permalink: /
---

* TOC {:toc}
1. TOC
{:toc}

0 comments on commit ad8f2a8

Please sign in to comment.