diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 8cf0e9f4f47..7ea6858cff0 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -6,8 +6,8 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
- title: 'QMK',
- tagline: 'Dinosaurs are cool',
+ title: 'QMK Firmware',
+ tagline: 'Potatoes are cool',
favicon: 'img/favicon.ico',
// Set the production url of your site here
@@ -50,18 +50,10 @@ const config = {
"gitbook",
// "ChangeLog"
],
- // Please change this to your repo.
- // Remove this to remove the "edit this page" links.
editUrl:
'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/qmk/qmk_firmware/edit/master/docs/',
- // },
+ blog: false,
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
@@ -72,21 +64,17 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
- // Replace with your project's social card
- image: 'img/docusaurus-social-card.jpg',
+ image: 'img/qmk-social-card.jpg',
navbar: {
title: 'QMK Firmware Docs',
logo: {
- alt: 'My Site Logo',
- src: 'img/logo.svg',
+ alt: 'QMK Firmware',
+ src: 'img/qmk-new-light.svg',
+ srcDark: 'img/qmk-new-dark.svg',
+ width: 32,
+ height: 32,
},
- items: [
- // {
- // type: 'docSidebar',
- // sidebarId: 'summary',
- // position: 'left',
- // label: 'Summary',
- // },
+ items: [
{
href: 'https://github.com/qmk/qmk_firmware',
label: 'GitHub',
@@ -102,37 +90,29 @@ const config = {
items: [
{
label: 'Docs',
- to: '/docs/',
+ to: '/',
},
],
},
{
title: 'Community',
items: [
- {
- label: 'Stack Overflow',
- href: 'https://stackoverflow.com/questions/tagged/docusaurus',
- },
{
label: 'Discord',
- href: 'https://discordapp.com/invite/docusaurus',
+ href: 'https://discord.gg/Uq7gcHh',
},
{
- label: 'Twitter',
- href: 'https://twitter.com/docusaurus',
+ label: 'Reddit',
+ href: 'https://reddit.com/r/olkb',
},
],
},
{
title: 'More',
items: [
- {
- label: 'Blog',
- to: '/blog',
- },
{
label: 'GitHub',
- href: 'https://github.com/facebook/docusaurus',
+ href: 'https://github.com/qmk/qmk_firmware',
},
],
},
@@ -142,7 +122,38 @@ const config = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
- },
+ },
+ // applied for - will fill out once we hear back
+ //
+ // algolia: {
+ // // The application ID provided by Algolia
+ // appId: 'YOUR_APP_ID',
+
+ // // Public API key: it is safe to commit it
+ // apiKey: 'YOUR_SEARCH_API_KEY',
+
+ // indexName: 'YOUR_INDEX_NAME',
+
+ // // Optional: see doc section below
+ // contextualSearch: true,
+
+ // // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
+ // externalUrlRegex: 'external\\.com|domain\\.com',
+
+ // // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
+ // replaceSearchResultPathname: {
+ // from: '/docs/', // or as RegExp: /\/docs\//
+ // to: '/',
+ // },
+
+ // // Optional: Algolia search parameters
+ // searchParameters: {},
+
+ // // Optional: path for search page that enabled by default (`false` to disable it)
+ // searchPagePath: 'search',
+
+ // //... other Algolia params
+ // },
}),
};
diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
index 2bc6a4cfdef..c79ca874a8a 100644
--- a/docs/src/css/custom.css
+++ b/docs/src/css/custom.css
@@ -6,25 +6,25 @@
/* You can override the default Infima variables here. */
:root {
- --ifm-color-primary: #2e8555;
- --ifm-color-primary-dark: #29784c;
- --ifm-color-primary-darker: #277148;
- --ifm-color-primary-darkest: #205d3b;
- --ifm-color-primary-light: #33925d;
- --ifm-color-primary-lighter: #359962;
- --ifm-color-primary-lightest: #3cad6e;
+ --ifm-color-primary: #855f2e;
+ --ifm-color-primary-dark: #785829;
+ --ifm-color-primary-darker: #715027;
+ --ifm-color-primary-darkest: #5d4020;
+ --ifm-color-primary-light: #926633;
+ --ifm-color-primary-lighter: #996435;
+ --ifm-color-primary-lightest: #ad733c;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}
/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
- --ifm-color-primary: #25c2a0;
- --ifm-color-primary-dark: #21af90;
- --ifm-color-primary-darker: #1fa588;
- --ifm-color-primary-darkest: #1a8870;
- --ifm-color-primary-light: #29d5b0;
- --ifm-color-primary-lighter: #32d8b4;
- --ifm-color-primary-lightest: #4fddbf;
+ --ifm-color-primary: #c26e25;
+ --ifm-color-primary-dark: #af7621;
+ --ifm-color-primary-darker: #a5641f;
+ --ifm-color-primary-darkest: #885a1a;
+ --ifm-color-primary-light: #d58229;
+ --ifm-color-primary-lighter: #d88232;
+ --ifm-color-primary-lightest: #dd964f;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}
diff --git a/docs/static/img/favicon.png b/docs/static/img/favicon.png
new file mode 100644
index 00000000000..509cebd8798
Binary files /dev/null and b/docs/static/img/favicon.png differ
diff --git a/docs/static/img/qmk-new-dark.svg b/docs/static/img/qmk-new-dark.svg
new file mode 100644
index 00000000000..5c0493932a0
--- /dev/null
+++ b/docs/static/img/qmk-new-dark.svg
@@ -0,0 +1,15 @@
+
+
+
diff --git a/docs/static/img/qmk-new-light.svg b/docs/static/img/qmk-new-light.svg
new file mode 100644
index 00000000000..84226b1d55a
--- /dev/null
+++ b/docs/static/img/qmk-new-light.svg
@@ -0,0 +1,15 @@
+
+
+
diff --git a/docs/static/img/qmk-social-card.jpg b/docs/static/img/qmk-social-card.jpg
new file mode 100644
index 00000000000..c2588ec70d8
Binary files /dev/null and b/docs/static/img/qmk-social-card.jpg differ