// @ts-check
require('dotenv').config();
/** @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',
favicon: 'design/web/favicon.ico',
organizationName: 'meshtastic',
projectName: 'meshtastic',
ssrTemplate: `
>
<% if (it.noIndex) { %>
<% } %>
<%~ it.headTags %>
<% it.metaAttributes.forEach((metaAttribute) => { %>
<%~ metaAttribute %>
<% }); %>
<% it.stylesheets.forEach((stylesheet) => { %>
<% }); %>
<% it.scripts.forEach((script) => { %>
<% }); %>
>
<%~ it.preBodyTags %>
<%~ it.appHtml %>
<% it.scripts.forEach((script) => { %>
<% }); %>
<%~ it.postBodyTags %>
`,
themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ {
colorMode: {
respectPrefersColorScheme: true,
},
navbar: {
title: 'Meshtastic',
hideOnScroll: true,
logo: {
alt: 'Meshtastic Logo',
src: 'design/logo/svg/Mesh_Logo_Black.svg',
srcDark: 'design/logo/svg/Mesh_Logo_White.svg',
},
items: [
/*
{
label: "Start Here",
to: "docs/academy",
activeBasePath: "docs/academy",
},
*/
{
label: 'About Meshtastic',
to: 'docs/about',
activeBasePath: 'docs/about',
},
/*
{
label: "Showcase",
to: "showcase",
activeBasePath: "showcase",
},
*/
{
label: 'Documentation',
items: [
{
label: 'Getting Started',
to: 'docs/getting-started',
},
// FIXME create configuration & settings landing page and adjust path below
{
label: 'Configuration & Settings',
to: 'docs/settings',
},
{
label: 'Hardware Details',
to: 'docs/hardware',
},
/*
{
label: "Mesh Radio Details",
to: "docs/mesh"
},
*/
{
label: 'Meshtastic Software',
to: 'docs/software',
},
],
},
{
label: 'Contribute',
items: [
{
label: 'Developers',
to: 'docs/developers',
},
{
label: 'Maintaining Documentation',
to: 'docs/developers/maintaining-documentation/overview',
},
{
label: 'Legal',
to: 'docs/legal',
},
],
},
{
label: 'Downloads',
to: 'downloads',
activeBasePath: 'downloads',
},
{
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: `Powered by ▲ Vercel | Meshtastic® is a registered trademark of Geeksville Industries LLC`,
},
algolia: {
appId: 'IG2GQB8L3V',
apiKey: '2e4348812173ec7ea6f7879c7032bb21',
indexName: 'meshtastic',
contextualSearch: false,
searchPagePath: 'search',
},
},
plugins: [
() => {
return {
name: 'docusaurus-tailwindcss',
configurePostCss(postcssOptions) {
// Appends TailwindCSS and AutoPrefixer.
postcssOptions.plugins.push(require('tailwindcss'));
postcssOptions.plugins.push(require('autoprefixer'));
return postcssOptions;
},
};
},
],
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'),
},
},
],
],
customFields: {
API_URL: process.env.API_URL,
},
};
module.exports = config;