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" ,
2022-03-17 03:06:28 -07:00
ssrTemplate : ` <!DOCTYPE html>
< html < % ~ it . htmlAttributes % >>
< head >
< meta charset = "UTF-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "generator" content = "Docusaurus v<%= it.version %>" >
< % if ( it . noIndex ) { % >
< meta name = "robots" content = "noindex, nofollow" / >
< % } % >
< script type = "application/ld+json" >
{
"@context" : "https://schema.org" ,
"@type" : "Organization" ,
"url" : "https://meshtastic.org" ,
"logo" : "https://meshtastic.org/design/logo/logo.svg"
}
< / s c r i p t >
< % ~ it . headTags % >
< % it . metaAttributes . forEach ( ( metaAttribute ) => { % >
< % ~ metaAttribute % >
< % } ) ; % >
< % it . stylesheets . forEach ( ( stylesheet ) => { % >
< link rel = "stylesheet" href = "<%= it.baseUrl %><%= stylesheet %>" / >
< % } ) ; % >
< % it . scripts . forEach ( ( script ) => { % >
< link rel = "preload" href = "<%= it.baseUrl %><%= script %>" as = "script" >
< % } ) ; % >
< / h e a d >
< body < % ~ it . bodyAttributes % >>
< % ~ it . preBodyTags % >
< div id = "__docusaurus" >
< % ~ it . appHtml % >
< / d i v >
< % it . scripts . forEach ( ( script ) => { % >
< script src = "<%= it.baseUrl %><%= script %>" > < / s c r i p t >
< % } ) ; % >
< % ~ it . postBodyTags % >
< / b o d y >
< / h t m l > ` ,
2021-12-21 03:44:01 -08:00
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-03-07 04:43:03 -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-03-07 04:43:03 -08:00
/ *
2022-02-11 22:38:55 -08:00
{
label : "Showcase" ,
to : "showcase" ,
activeBasePath : "showcase" ,
} ,
2022-02-23 08:35:41 -08:00
* /
2022-01-19 11:32:54 -08:00
{
label : "Documentation" ,
items : [
{
label : "Getting Started" ,
to : "docs/getting-started" ,
} ,
2022-02-23 10:10:14 -08:00
// FIXME create configuration & settings landing page and adjust path below
2022-01-19 11:32:54 -08:00
{
2022-02-23 10:10:14 -08:00
label : "Configuration & Settings" ,
2022-01-19 11:32:54 -08:00
to : "docs/settings" ,
} ,
{
label : "Hardware Details" ,
to : "docs/hardware" ,
} ,
2022-03-07 04:43:03 -08:00
/ *
2022-02-23 10:10:22 -08:00
{
label : "Mesh Radio Details" ,
to : "docs/mesh"
} ,
* /
2022-02-23 08:35:28 -08:00
{
label : "Meshtastic Software" ,
to : "docs/software" ,
} ,
] ,
} ,
{
label : "Contribute" ,
items : [
2022-01-19 11:32:54 -08:00
{
2022-02-23 10:10:14 -08:00
label : "Developers" ,
2022-01-19 11:32:54 -08:00
to : "docs/developers" ,
} ,
{
2022-02-22 12:07:34 -08:00
label : "Maintaining Documentation" ,
to : "docs/developers/maintaining-documentation/overview" ,
2022-01-19 11:32:54 -08:00
} ,
{
label : "Legal" ,
to : "docs/legal" ,
} ,
] ,
} ,
2021-12-21 03:44:01 -08:00
{
2022-02-03 10:13:21 -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 : {
2022-01-27 15:22:15 -08:00
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 : [
{
2022-03-07 04:43:03 -08:00
title : "Learn" ,
2022-02-05 06:23:56 -08:00
items : [
2022-02-25 13:51:14 -08:00
{
2022-03-07 04:43:03 -08:00
label : "About" ,
to : "docs/about" ,
2022-02-25 13:51:14 -08:00
} ,
2022-02-05 06:23:56 -08:00
{
2022-03-07 04:43:03 -08:00
label : "Getting Started" ,
to : "docs/getting-started" ,
2022-02-05 06:23:56 -08:00
} ,
{
2022-03-07 04:43:03 -08:00
label : "Hardware" ,
to : "docs/hardware" ,
2022-02-05 06:23:56 -08:00
} ,
{
2022-03-07 04:43:03 -08:00
label : "Settings" ,
to : "docs/settings" ,
2022-02-05 06:23:56 -08:00
} ,
] ,
} ,
{
2022-03-07 04:43:03 -08:00
title : "Community" ,
2022-02-03 12:50:07 -08:00
items : [
{
2022-03-07 04:43:03 -08:00
label : "Discord" ,
to : "https://discord.com/invite/UQJ5QuM7vq" ,
2022-02-03 12:50:07 -08:00
} ,
{
2022-03-07 04:43:03 -08:00
label : "Forum" ,
to : "https://meshtastic.discourse.group" ,
2022-02-03 12:50:07 -08:00
} ,
2022-02-11 22:39:17 -08:00
{
2022-03-07 04:43:03 -08:00
label : "Reddit" ,
to : "https://reddit.com/r/meshtastic" ,
2022-02-11 22:39:17 -08:00
} ,
{
2022-03-07 04:43:03 -08:00
label : "YouTube" ,
to : "https://www.youtube.com/meshtastic" ,
2022-02-11 22:39:17 -08:00
} ,
2022-02-03 12:50:07 -08:00
] ,
} ,
2022-02-05 06:23:56 -08:00
{
2022-03-07 04:43:03 -08:00
title : "Legal" ,
2022-02-05 06:23:56 -08:00
items : [
{
2022-03-07 04:43:03 -08:00
label : "Privacy" ,
to : "docs/legal/privacy" ,
2022-02-05 06:23:56 -08:00
} ,
{
2022-03-07 04:43:03 -08:00
label : "Licensing" ,
to : "docs/legal/licensing" ,
2022-02-05 06:23:56 -08:00
} ,
{
2022-03-07 04:43:03 -08:00
label : "Trademark" ,
to : "docs/legal/trademark" ,
2022-02-05 06:23:56 -08:00
} ,
] ,
} ,
{
2022-03-07 04:43:03 -08:00
title : "Resources" ,
2022-02-05 06:23:56 -08:00
items : [
{
2022-03-07 04:43:03 -08:00
label : "GitHub" ,
to : "https://github.com/meshtastic" ,
2022-02-05 06:23:56 -08:00
} ,
2022-02-22 12:07:34 -08:00
{
2022-03-07 04:43:03 -08:00
label : "Contribute" ,
to : "docs/developers" ,
2022-02-22 12:07:34 -08:00
} ,
2022-02-05 06:23:56 -08:00
] ,
} ,
2022-02-03 12:50:07 -08:00
] ,
2021-12-21 03:44:01 -08:00
} ,
algolia : {
2022-03-07 04:43:03 -08:00
appId : "IG2GQB8L3V" ,
apiKey : "2e4348812173ec7ea6f7879c7032bb21" ,
2021-12-21 03:44:01 -08:00
indexName : "meshtastic" ,
contextualSearch : false ,
2022-03-07 04:43:03 -08:00
searchPagePath : "search" ,
2021-12-21 03:44:01 -08:00
} ,
} ,
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
customFields : {
API _URL : process . env . API _URL ,
} ,
2021-12-21 03:44:01 -08:00
} ;
module . exports = config ;
