mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add markdown light/darkmode element

Browse source
This commit is contained in:
Sacha Weatherstone 2022-04-07 19:59:15 +10:00
parent 83c612f011
commit 0d56796882
4 changed files with 268 additions and 193 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
docs/developers/maintaining-documentation/style-guides/markdown-features.mdx Normal file
View file

@ -0,0 +1,49 @@
---
id: markdown-features
title: Style Guide - Markdown Features
sidebar_label: Markdown-Features
---
import { Dark, Light } from '/src/components/ColorMode';
## Overview
We have developed several [React](https://reactjs.org/) components for assisting with writing documentation.
## Features
### Light/Dark Mode Switch
#### Usage:
```jsx
import { Dark, Light } from '/src/components/ColorMode';
<Dark>
<p>Dark</p>
</Dark>
<Light>
<p>Light</p>
</Light>
```
#### Demo:
<Dark>
<div className="not-prose rounded-lg bg-primary shadow-md">
<p className="p-2 text-lg font-medium">This is only shown in dark mode.</p>
<img
src="https://picsum.photos/id/101/600/200"
className="w-full rounded-lg shadow-md"
/>
</div>
</Dark>
<Light>
<div className="not-prose rounded-lg border bg-primary shadow-md">
<p className="p-2 text-lg font-medium">This is only shown in dark mode.</p>
<img
src="https://picsum.photos/id/1028/600/200"
className="w-full rounded-lg shadow-md"
/>
</div>
</Light>

385
sidebars.js
View file

@ -1,312 +1,313 @@
module.exports = { module.exports = {
About: { About: {
"About Meshtastic": [ 'About Meshtastic': [
"about/overview", 'about/overview',
{ {
Concepts: [ Concepts: [
"about/concepts/overview", 'about/concepts/overview',
"about/concepts/channels", 'about/concepts/channels',
"about/concepts/clients", 'about/concepts/clients',
"about/concepts/external-devices", 'about/concepts/external-devices',
"about/concepts/internet", 'about/concepts/internet',
"about/concepts/mesh", 'about/concepts/mesh',
], ],
}, },
"about/expectations", 'about/expectations',
{ {
FAQs: [ FAQs: [
"faq/faq", 'faq/faq',
"faq/antenna", 'faq/antenna',
"faq/bluetooth", 'faq/bluetooth',
"faq/channel", 'faq/channel',
{ {
Clients: [ Clients: [
"faq/client-android", 'faq/client-android',
"faq/client-python-cli", 'faq/client-python-cli',
"faq/client-ios", 'faq/client-ios',
"faq/client-web", 'faq/client-web',
], ],
}, },
"faq/device", 'faq/device',
{ {
"Flashing Firmware": ["faq/m-flasher"], 'Flashing Firmware': ['faq/m-flasher'],
}, },
"faq/mesh", 'faq/mesh',
"faq/mqtt", 'faq/mqtt',
"faq/modules", 'faq/modules',
"faq/wifi", 'faq/wifi',
], ],
}, },
], ],
}, },
Software: { Software: {
Software: [ Software: [
"software/overview", 'software/overview',
{ {
"Meshtastic device": [ 'Meshtastic device': [
"software/device/device-firmware", 'software/device/device-firmware',
"software/device/device-channels", 'software/device/device-channels',
"software/device/device-remote-admin", 'software/device/device-remote-admin',
"software/device/remote-hardware-service", 'software/device/remote-hardware-service',
"software/device/device-power", 'software/device/device-power',
"software/device/critical-error-codes", 'software/device/critical-error-codes',
"software/device/ham", 'software/device/ham',
], ],
}, },
{ {
"Meshtastic Android": [ 'Meshtastic Android': [
"software/android/android-installation", 'software/android/android-installation',
"software/android/android-usage", 'software/android/android-usage',
], ],
}, },
{ {
"Meshtastic Apple": [ 'Meshtastic Apple': [
"software/apple/ios-development", 'software/apple/ios-development',
"software/apple/ios", 'software/apple/ios',
"software/apple/ipados", 'software/apple/ipados',
"software/apple/macos", 'software/apple/macos',
], ],
}, },
{ {
"Meshtastic.js": [ 'Meshtastic.js': [
"software/js/getting-started", 'software/js/getting-started',
"software/js/connecting", 'software/js/connecting',
"software/js/events", 'software/js/events',
"software/js/http-api", 'software/js/http-api',
{ {
type: "link", type: 'link',
label: "API Docs", label: 'API Docs',
href: "https://js.meshtastic.org", href: 'https://js.meshtastic.org',
}, },
], ],
}, },
{ {
"Meshtastic-python": [ 'Meshtastic-python': [
"software/python/python-installation", 'software/python/python-installation',
"software/python/python-standalone", 'software/python/python-standalone',
"software/python/python-cli", 'software/python/python-cli',
"software/python/python-uses", 'software/python/python-uses',
"software/python/python-stream", 'software/python/python-stream',
{ {
type: "link", type: 'link',
label: "API Docs", label: 'API Docs',
href: "https://python.meshtastic.org/", href: 'https://python.meshtastic.org/',
}, },
], ],
}, },
{ {
Modules: [ Modules: [
"software/modules/modules", 'software/modules/modules',
"software/modules/range-test-module", 'software/modules/range-test-module',
"software/modules/ext-notif-module", 'software/modules/ext-notif-module',
"software/modules/canned-message-module", 'software/modules/canned-message-module',
"software/modules/serial-module", 'software/modules/serial-module',
"software/modules/store-forward-module", 'software/modules/store-forward-module',
"software/modules/telemetry-module", 'software/modules/telemetry-module',
], ],
}, },
{ {
"Web interface": [ 'Web interface': [
"software/web/web-app-software", 'software/web/web-app-software',
"software/web/web-partitions-software", 'software/web/web-partitions-software',
"software/web/web-development-software", 'software/web/web-development-software',
], ],
}, },
{ {
"Community projects": [ 'Community projects': [
"software/community/community-overview", 'software/community/community-overview',
"software/community/community-atak", 'software/community/community-atak',
"software/community/community-pygui", 'software/community/community-pygui',
"software/community/community-go", 'software/community/community-go',
], ],
}, },
{ {
Other: [ Other: [
"software/other/sw-design", 'software/other/sw-design',
"software/other/remote-hardware-service", 'software/other/remote-hardware-service',
"software/other/rak815", 'software/other/rak815',
"software/other/power", 'software/other/power',
"software/other/pinetab", 'software/other/pinetab',
"software/other/nrf52-TODO", 'software/other/nrf52-TODO',
"software/other/mqtt", 'software/other/mqtt',
"software/other/install-OSX", 'software/other/install-OSX',
"software/other/esp32-arduino-build", 'software/other/esp32-arduino-build',
"software/other/ant", 'software/other/ant',
"software/other/docker", 'software/other/docker',
], ],
}, },
], ],
"Additional Documentation": [ 'Additional Documentation': [
{ type: "ref", id: "getting-started/overview" }, { type: 'ref', id: 'getting-started/overview' },
{ type: "ref", id: "settings/overview" }, { type: 'ref', id: 'settings/overview' },
{ type: "ref", id: "hardware/overview" }, { type: 'ref', id: 'hardware/overview' },
{ type: "ref", id: "developers/overview" }, { type: 'ref', id: 'developers/overview' },
{ type: "ref", id: "developers/maintaining-documentation/overview" }, { type: 'ref', id: 'developers/maintaining-documentation/overview' },
{ type: "ref", id: "legal/overview" }, { type: 'ref', id: 'legal/overview' },
], ],
}, },
Configuration: { Configuration: {
"Getting Started": [ 'Getting Started': [
"getting-started/overview", 'getting-started/overview',
{ {
"Flashing firmware": [ 'Flashing firmware': [
"getting-started/flashing-firmware", 'getting-started/flashing-firmware',
"getting-started/meshtastic-flasher", 'getting-started/meshtastic-flasher',
{ {
"Manual Method": [ 'Manual Method': [
"getting-started/flashing-esp32", 'getting-started/flashing-esp32',
"getting-started/flashing-nrf52", 'getting-started/flashing-nrf52',
], ],
}, },
], ],
}, },
{ {
"Connect to Device": ["getting-started/clients"], 'Connect to Device': ['getting-started/clients'],
}, },
"getting-started/first-steps", 'getting-started/first-steps',
], ],
"Device Settings": [ 'Device Settings': [
"settings/overview", 'settings/overview',
"settings/channel", 'settings/channel',
"settings/gps", 'settings/gps',
"settings/ham", 'settings/ham',
"settings/mqtt", 'settings/mqtt',
"settings/power", 'settings/power',
"settings/router", 'settings/router',
"settings/wifi", 'settings/wifi',
{ {
Modules: [ Modules: [
"settings/canned-message-module", 'settings/canned-message-module',
"settings/input-broker-module", 'settings/input-broker-module',
"settings/external-notification-module", 'settings/external-notification-module',
"settings/range-test-module", 'settings/range-test-module',
"settings/serial-module", 'settings/serial-module',
"settings/store-and-forward-module", 'settings/store-and-forward-module',
"settings/telemetry-module", 'settings/telemetry-module',
], ],
Advanced: ["settings/channel-advanced", "settings/misc"], Advanced: ['settings/channel-advanced', 'settings/misc'],
}, },
], ],
"Additional Documentation": [ 'Additional Documentation': [
{ type: "ref", id: "hardware/overview" }, { type: 'ref', id: 'hardware/overview' },
{ type: "ref", id: "software/overview" }, { type: 'ref', id: 'software/overview' },
{ type: "ref", id: "developers/overview" }, { type: 'ref', id: 'developers/overview' },
{ type: "ref", id: "developers/maintaining-documentation/overview" }, { type: 'ref', id: 'developers/maintaining-documentation/overview' },
{ type: "ref", id: "legal/overview" }, { type: 'ref', id: 'legal/overview' },
], ],
}, },
Hardware: { Hardware: {
Hardware: [ Hardware: [
"hardware/overview", 'hardware/overview',
{ {
type: "link", type: 'link',
label: "Hardware List", label: 'Hardware List',
href: "/hardware", href: '/hardware',
}, },
{ {
"Supported Hardware": [ 'Supported Hardware': [
"hardware/supported/tbeam", 'hardware/supported/tbeam',
"hardware/supported/lora", 'hardware/supported/lora',
"hardware/supported/heltec", 'hardware/supported/heltec',
"hardware/supported/techo", 'hardware/supported/techo',
"hardware/supported/wisBlock", 'hardware/supported/wisBlock',
"hardware/supported/linux", 'hardware/supported/linux',
], ],
}, },
"hardware/buttons", 'hardware/buttons',
"hardware/battery", 'hardware/battery',
"hardware/gpsmodule", 'hardware/gpsmodule',
{ {
Antennas: [ Antennas: [
"hardware/antenna/antenna", 'hardware/antenna/antenna',
"hardware/antenna/aerials", 'hardware/antenna/aerials',
"hardware/antenna/non-aerial", 'hardware/antenna/non-aerial',
"hardware/antenna/antenna-testing", 'hardware/antenna/antenna-testing',
"hardware/antenna/resources", 'hardware/antenna/resources',
], ],
}, },
], ],
"Additional Documentation": [ 'Additional Documentation': [
{ type: "ref", id: "getting-started/overview" }, { type: 'ref', id: 'getting-started/overview' },
{ type: "ref", id: "settings/overview" }, { type: 'ref', id: 'settings/overview' },
{ type: "ref", id: "software/overview" }, { type: 'ref', id: 'software/overview' },
{ type: "ref", id: "developers/overview" }, { type: 'ref', id: 'developers/overview' },
{ type: "ref", id: "developers/maintaining-documentation/overview" }, { type: 'ref', id: 'developers/maintaining-documentation/overview' },
{ type: "ref", id: "legal/overview" }, { type: 'ref', id: 'legal/overview' },
], ],
}, },
Contribute: { Contribute: {
Developers: [ Developers: [
"developers/overview", 'developers/overview',
{ {
Protobufs: ["developers/protobufs/api"], Protobufs: ['developers/protobufs/api'],
}, },
"developers/api", 'developers/api',
"developers/publish", 'developers/publish',
{ {
Firmware: [ Firmware: [
"developers/firmware/build", 'developers/firmware/build',
"developers/firmware/stacktrace-decode", 'developers/firmware/stacktrace-decode',
"developers/firmware/device-api", 'developers/firmware/device-api',
"developers/firmware/radio-settings", 'developers/firmware/radio-settings',
"developers/firmware/mesh-alg", 'developers/firmware/mesh-alg',
"developers/firmware/encryption", 'developers/firmware/encryption',
"developers/firmware/portnum", 'developers/firmware/portnum',
"developers/firmware/module-api", 'developers/firmware/module-api',
"developers/firmware/http-api", 'developers/firmware/http-api',
"developers/firmware/documents", 'developers/firmware/documents',
], ],
}, },
{ {
"Android App": [ 'Android App': [
"developers/android/build-app", 'developers/android/build-app',
"developers/android/mapbox", 'developers/android/mapbox',
], ],
"Maintaining Documentation": [ 'Maintaining Documentation': [
"developers/maintaining-documentation/overview", 'developers/maintaining-documentation/overview',
{ {
Dependencies: [ Dependencies: [
"developers/maintaining-documentation/docusaurus", 'developers/maintaining-documentation/docusaurus',
"developers/maintaining-documentation/github", 'developers/maintaining-documentation/github',
"developers/maintaining-documentation/vercel", 'developers/maintaining-documentation/vercel',
], ],
}, },
{ {
Examples: [ Examples: [
"developers/maintaining-documentation/serve-docs-locally", 'developers/maintaining-documentation/serve-docs-locally',
], ],
}, },
{ {
"Style Guides": [ 'Style Guides': [
"developers/maintaining-documentation/style-guides/style-guide-settings", 'developers/maintaining-documentation/style-guides/markdown-features',
'developers/maintaining-documentation/style-guides/style-guide-settings',
], ],
}, },
], ],
}, },
], ],
"Additional Documentation": [ 'Additional Documentation': [
{ type: "ref", id: "getting-started/overview" }, { type: 'ref', id: 'getting-started/overview' },
{ type: "ref", id: "settings/overview" }, { type: 'ref', id: 'settings/overview' },
{ type: "ref", id: "hardware/overview" }, { type: 'ref', id: 'hardware/overview' },
{ type: "ref", id: "software/overview" }, { type: 'ref', id: 'software/overview' },
{ type: "ref", id: "legal/overview" }, { type: 'ref', id: 'legal/overview' },
{ type: "ref", id: "developers/overview" }, { type: 'ref', id: 'developers/overview' },
], ],
}, },
Legal: { Legal: {
Legal: [ Legal: [
"legal/overview", 'legal/overview',
"legal/licensing", 'legal/licensing',
"legal/trademark", 'legal/trademark',
"legal/privacy", 'legal/privacy',
], ],
"Additional Documentation": [ 'Additional Documentation': [
{ type: "ref", id: "getting-started/overview" }, { type: 'ref', id: 'getting-started/overview' },
{ type: "ref", id: "settings/overview" }, { type: 'ref', id: 'settings/overview' },
{ type: "ref", id: "hardware/overview" }, { type: 'ref', id: 'hardware/overview' },
{ type: "ref", id: "software/overview" }, { type: 'ref', id: 'software/overview' },
{ type: "ref", id: "developers/overview" }, { type: 'ref', id: 'developers/overview' },
], ],
}, },
}; };

13
src/components/ColorMode.tsx Normal file
View file

@ -0,0 +1,13 @@
import React from 'react';
export interface ColorModeProps {
children: React.ReactNode;
}
export const Dark = ({ children }: ColorModeProps): JSX.Element => {
return <div className="hideLight">{children}</div>;
};
export const Light = ({ children }: ColorModeProps): JSX.Element => {
return <div className="hideDark">{children}</div>;
};

12
src/css/custom.css
View file

@ -139,4 +139,16 @@ a + .navbar__link > svg {
[data-theme="dark"] .markdown { [data-theme="dark"] .markdown {
@apply prose-invert; @apply prose-invert;
} }
[data-theme="dark"] .hideDark {
@apply hidden
}
[data-theme="dark"] .hideLight {
@apply block
}
.hideLight {
@apply hidden
}
.hideDark {
@apply block
}
} }