96bd927be2
Now, instead of always defaulting to light theme, documentation, docs will default to the color scheme based by the user preference (reported by web browser as a `prefers-color-scheme` media query). It is still possible for user to change the theme by using the switch next to the search box. His preference will be remembered.
134 lines
3.8 KiB
JavaScript
134 lines
3.8 KiB
JavaScript
const path = require("path");
|
|
|
|
module.exports = {
|
|
title: "ZMK Firmware",
|
|
tagline: "Modern, open source keyboard firmware",
|
|
url: "https://zmkfirmware.dev",
|
|
baseUrl: "/",
|
|
favicon: "img/favicon.ico",
|
|
organizationName: "zmkfirmware", // Usually your GitHub org/user name.
|
|
projectName: "zmk", // Usually your repo name.
|
|
plugins: [path.resolve(__dirname, "src/docusaurus-tree-sitter-plugin")],
|
|
themeConfig: {
|
|
colorMode: {
|
|
respectPrefersColorScheme: true,
|
|
},
|
|
googleAnalytics: {
|
|
trackingID: "UA-145201102-2",
|
|
anonymizeIP: true,
|
|
},
|
|
// sidebarCollapsible: false,
|
|
navbar: {
|
|
title: "ZMK Firmware",
|
|
logo: {
|
|
alt: "ZMK Logo",
|
|
src: "img/zmk_logo.svg",
|
|
},
|
|
items: [
|
|
{
|
|
to: "docs",
|
|
activeBasePath: "docs",
|
|
label: "Docs",
|
|
position: "left",
|
|
},
|
|
{ to: "blog", label: "Blog", position: "left" },
|
|
{
|
|
to: "power-profiler",
|
|
label: "Power Profiler",
|
|
position: "left",
|
|
},
|
|
{
|
|
href: "https://github.com/zmkfirmware/zmk",
|
|
label: "GitHub",
|
|
position: "right",
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: "dark",
|
|
links: [
|
|
{
|
|
title: "Docs",
|
|
items: [
|
|
{
|
|
label: "Getting Started",
|
|
to: "docs/",
|
|
},
|
|
{
|
|
label: "Development",
|
|
to: "docs/development/setup/",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: "Community",
|
|
items: [
|
|
// {
|
|
// label: "Stack Overflow",
|
|
// href: "https://stackoverflow.com/questions/tagged/docusaurus",
|
|
// },
|
|
{
|
|
label: "Discord",
|
|
href:
|
|
(process.env.URL || "https://zmkfirmware.dev") +
|
|
"/community/discord/invite",
|
|
},
|
|
{
|
|
label: "Twitter",
|
|
href: "https://twitter.com/ZMKFirmware",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: "More",
|
|
items: [
|
|
{
|
|
label: "Blog",
|
|
to: "blog",
|
|
},
|
|
{
|
|
label: "GitHub",
|
|
href: "https://github.com/zmkfirmware/zmk",
|
|
},
|
|
{
|
|
html: `
|
|
<a href="https://www.netlify.com" target="_blank" rel="noreferrer noopener" aria-label="Deploys by Netlify">
|
|
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
|
|
</a>
|
|
`,
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `Copyright © ${new Date().getFullYear()} ZMK Project Contributors. <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/80x15.png" /></a>`,
|
|
},
|
|
algolia: {
|
|
apiKey: "75325855fc90356828fe212d38e5ca34",
|
|
indexName: "zmkfirmware",
|
|
},
|
|
},
|
|
presets: [
|
|
[
|
|
"@docusaurus/preset-classic",
|
|
{
|
|
docs: {
|
|
// It is recommended to set document id as docs home page (`docs/` path).
|
|
sidebarPath: require.resolve("./sidebars.js"),
|
|
// Please change this to your repo.
|
|
editUrl: "https://github.com/zmkfirmware/zmk/edit/main/docs/",
|
|
},
|
|
blog: {
|
|
showReadingTime: true,
|
|
// Please change this to your repo.
|
|
editUrl: "https://github.com/zmkfirmware/zmk/edit/main/docs/",
|
|
},
|
|
theme: {
|
|
customCss: [
|
|
require.resolve("./src/css/custom.css"),
|
|
require.resolve("./src/css/codes.css"),
|
|
],
|
|
},
|
|
},
|
|
],
|
|
],
|
|
};
|