mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-01 13:32:04 +00:00
150 lines
4.0 KiB
JavaScript
150 lines
4.0 KiB
JavaScript
// @ts-check
|
|
// Note: type annotations allow type checking and IDEs autocompletion
|
|
|
|
const lightCodeTheme = require('prism-react-renderer/themes/github');
|
|
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
title: 'QMK',
|
|
tagline: 'Dinosaurs are cool',
|
|
favicon: 'img/favicon.ico',
|
|
|
|
// Set the production url of your site here
|
|
url: 'https://docs.qmk.fm',
|
|
// Set the /<baseUrl>/ pathname under which your site is served
|
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
|
baseUrl: '/',
|
|
|
|
// GitHub pages deployment config.
|
|
// If you aren't using GitHub pages, you don't need these.
|
|
organizationName: 'qmk', // Usually your GitHub org/user name.
|
|
projectName: 'qmk_firmware', // Usually your repo name.
|
|
|
|
onBrokenLinks: 'throw',
|
|
onBrokenMarkdownLinks: 'warn',
|
|
|
|
// Even if you don't use internalization, you can use this field to set useful
|
|
// metadata like html lang. For example, if your site is Chinese, you may want
|
|
// to replace "en" with "zh-Hans".
|
|
i18n: {
|
|
defaultLocale: 'en',
|
|
locales: ['en'],
|
|
},
|
|
|
|
presets: [
|
|
[
|
|
'classic',
|
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
|
({
|
|
docs: {
|
|
sidebarPath: require.resolve('./sidebars.js'),
|
|
path: ".",
|
|
routeBasePath: "/",
|
|
exclude: [
|
|
"node_modules",
|
|
"src",
|
|
"static",
|
|
"ja",
|
|
"zh-cn",
|
|
"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/',
|
|
// },
|
|
theme: {
|
|
customCss: require.resolve('./src/css/custom.css'),
|
|
},
|
|
}),
|
|
],
|
|
],
|
|
|
|
themeConfig:
|
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
|
({
|
|
// Replace with your project's social card
|
|
image: 'img/docusaurus-social-card.jpg',
|
|
navbar: {
|
|
title: 'QMK Firmware Docs',
|
|
logo: {
|
|
alt: 'My Site Logo',
|
|
src: 'img/logo.svg',
|
|
},
|
|
items: [
|
|
// {
|
|
// type: 'docSidebar',
|
|
// sidebarId: 'summary',
|
|
// position: 'left',
|
|
// label: 'Summary',
|
|
// },
|
|
{
|
|
href: 'https://github.com/qmk/qmk_firmware',
|
|
label: 'GitHub',
|
|
position: 'right',
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: 'dark',
|
|
links: [
|
|
{
|
|
title: 'Docs',
|
|
items: [
|
|
{
|
|
label: 'Docs',
|
|
to: '/docs/',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Community',
|
|
items: [
|
|
{
|
|
label: 'Stack Overflow',
|
|
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
|
|
},
|
|
{
|
|
label: 'Discord',
|
|
href: 'https://discordapp.com/invite/docusaurus',
|
|
},
|
|
{
|
|
label: 'Twitter',
|
|
href: 'https://twitter.com/docusaurus',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'More',
|
|
items: [
|
|
{
|
|
label: 'Blog',
|
|
to: '/blog',
|
|
},
|
|
{
|
|
label: 'GitHub',
|
|
href: 'https://github.com/facebook/docusaurus',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `Copyright © ${new Date().getFullYear()} QMK. Built with Docusaurus.`,
|
|
},
|
|
prism: {
|
|
theme: lightCodeTheme,
|
|
darkTheme: darkCodeTheme,
|
|
},
|
|
}),
|
|
};
|
|
|
|
module.exports = config;
|