meshtastic/docusaurus.config.js

204 lines
5 KiB
JavaScript
Raw Normal View History

2021-12-21 03:44:01 -08:00
// @ts-check
2021-12-22 22:22:01 -08:00
require("dotenv").config();
2021-12-21 03:44:01 -08:00
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Meshtastic",
tagline: "Open Source hiking, pilot, skiing and secure GPS mesh communicator",
url: "https://meshtastic.org",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
2021-12-22 06:53:13 -08:00
favicon: "design/web/favicon.ico",
2021-12-21 03:44:01 -08:00
organizationName: "meshtastic",
projectName: "meshtastic",
themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ {
colorMode: {
respectPrefersColorScheme: true,
},
navbar: {
title: "Meshtastic",
hideOnScroll: true,
logo: {
alt: "Meshtastic Logo",
2021-12-22 06:53:13 -08:00
src: "design/logo/svg/Mesh_Logo_Black.svg",
srcDark: "design/logo/svg/Mesh_Logo_White.svg",
2021-12-21 03:44:01 -08:00
},
2022-01-10 17:57:10 -08:00
2021-12-21 03:44:01 -08:00
items: [
2022-01-10 17:57:10 -08:00
/*
2022-01-08 17:03:14 -08:00
{
label: "Start Here",
to: "docs/academy",
activeBasePath: "docs/academy",
},
2022-02-11 22:38:30 -08:00
*/
/*
{
label: "About Meshtastic",
to: "docs/about",
activeBasePath: "docs/about",
},
2022-01-10 17:57:10 -08:00
*/
2022-02-11 22:38:55 -08:00
{
label: "Showcase",
to: "showcase",
activeBasePath: "showcase",
},
2022-01-19 11:32:54 -08:00
{
label: "Documentation",
items: [
{
2022-02-07 13:52:01 -08:00
label: "Meshtastic Software",
2022-01-19 11:32:54 -08:00
to: "docs/software",
},
{
label: "Getting Started",
to: "docs/getting-started",
},
{
label: "Device Settings",
to: "docs/settings",
},
{
label: "Hardware Details",
to: "docs/hardware",
},
{
label: "Contribute to Meshtastic",
to: "docs/developers",
},
{
label: "About this Documentation",
to: "docs/about-documentation",
},
{
label: "Legal",
to: "docs/legal",
},
],
},
2021-12-21 03:44:01 -08:00
{
label: "Downloads",
to: "downloads",
activeBasePath: "downloads",
2021-12-21 03:44:01 -08:00
},
{
href: "https://meshtastic.discourse.group",
label: "Forum",
position: "left",
},
{
href: "https://github.com/meshtastic/meshtastic",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
},
],
},
footer: {
copyright: `<a href="https://vercel.com/?utm_source=meshtastic&utm_campaign=oss" style="color: var(--ifm-footer-color)">Powered by ▲ Vercel</a> | Meshtastic® is a registered trademark of Geeksville Industries LLC`,
2022-02-03 12:50:07 -08:00
links: [
{
title: 'Learn',
items: [
{
label: 'Getting Started',
to: 'docs/getting-started',
},
{
label: 'About',
to: 'docs/about-documentation',
},
{
label: 'Hardware',
to: 'docs/hardware',
},
{
label: 'Settings',
to: 'docs/settings',
},
],
},
{
title: 'Community',
2022-02-03 12:50:07 -08:00
items: [
{
label: 'Discord',
to: 'https://discord.com/invite/UQJ5QuM7vq',
},
{
label: 'Forum',
to: 'https://meshtastic.discourse.group',
},
{
label: 'Reddit',
to: 'https://reddit.com/r/meshtastic',
},
{
label: 'YouTube',
to: 'https://www.youtube.com/meshtastic',
},
2022-02-03 12:50:07 -08:00
],
},
{
title: 'Legal',
items: [
{
label: 'Privacy',
to: 'docs/legal/privacy',
},
{
label: 'Licensing',
to: 'docs/legal/licensing',
},
{
label: 'Trademark',
to: 'docs/legal/trademark',
},
],
},
{
title: 'Resources',
items: [
{
label: 'GitHub',
to: 'https://github.com/meshtastic',
},
],
},
2022-02-03 12:50:07 -08:00
],
2021-12-21 03:44:01 -08:00
},
algolia: {
apiKey: "01ad7e13d3fe392d2ad26da3c69dbc21",
indexName: "meshtastic",
contextualSearch: false,
searchParameters: {},
},
},
presets: [
[
"@docusaurus/preset-classic",
/** @type {import('@docusaurus/preset-classic').Options} */
{
docs: {
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/meshtastic/meshtastic/edit/master/",
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
2021-12-22 22:22:01 -08:00
plugins: ["@docusaurus/plugin-ideal-image"],
customFields: {
API_URL: process.env.API_URL,
},
2021-12-21 03:44:01 -08:00
};
module.exports = config;