forked from kofal.net/zmk
Initial work on basic documentation.
This commit is contained in:
103
docs/docusaurus.config.js
Normal file
103
docs/docusaurus.config.js
Normal file
@@ -0,0 +1,103 @@
|
||||
module.exports = {
|
||||
title: "ZMK Keyboard Firmware",
|
||||
tagline: "Modern, open source keyboard firmware ",
|
||||
url: "https://your-docusaurus-test-site.com",
|
||||
baseUrl: "/",
|
||||
favicon: "img/favicon.ico",
|
||||
organizationName: "zmkproject", // Usually your GitHub org/user name.
|
||||
projectName: "zmk", // Usually your repo name.
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
title: "ZMK",
|
||||
logo: {
|
||||
alt: "ZMK Logo",
|
||||
src: "img/logo.svg",
|
||||
},
|
||||
links: [
|
||||
{
|
||||
to: "docs/",
|
||||
activeBasePath: "docs",
|
||||
label: "Docs",
|
||||
position: "left",
|
||||
},
|
||||
{ to: "blog", label: "Blog", position: "left" },
|
||||
{
|
||||
href: "https://gitlab.com/zmkproject/zmk",
|
||||
label: "GitLab",
|
||||
position: "right",
|
||||
},
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: "dark",
|
||||
links: [
|
||||
{
|
||||
title: "Docs",
|
||||
items: [
|
||||
{
|
||||
label: "Style Guide",
|
||||
to: "docs/",
|
||||
},
|
||||
{
|
||||
label: "Second Doc",
|
||||
to: "docs/doc2/",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
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()} My Project, Inc. Built with Docusaurus.`,
|
||||
},
|
||||
},
|
||||
presets: [
|
||||
[
|
||||
"@docusaurus/preset-classic",
|
||||
{
|
||||
docs: {
|
||||
// It is recommended to set document id as docs home page (`docs/` path).
|
||||
homePageId: "intro",
|
||||
sidebarPath: require.resolve("./sidebars.js"),
|
||||
// Please change this to your repo.
|
||||
editUrl: "https://githlab.com/zmkproject/zmk/edit/master/docs/",
|
||||
},
|
||||
blog: {
|
||||
showReadingTime: true,
|
||||
// Please change this to your repo.
|
||||
editUrl: "https://gitlab.com/zmkproject/zmk/edit/master/docs/blog/",
|
||||
},
|
||||
theme: {
|
||||
customCss: require.resolve("./src/css/custom.css"),
|
||||
},
|
||||
},
|
||||
],
|
||||
],
|
||||
};
|
||||
Reference in New Issue
Block a user