mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 06:04:22 -08:00

Meshtastic project website and documentation

Find a file

pdxlocations 3795f6a2c2 MQTT subpage path forwrading		2024-02-08 10:04:04 -08:00
.github	update CI	2024-01-06 11:08:07 +10:00
.vscode	add MDX extension to recommended	2024-01-06 11:06:22 +10:00
docs	Add triple press button action for heltec (#976 )	2024-02-07 17:47:00 -06:00
src	fix facebook image	2024-02-03 21:48:45 -08:00
static	convert png,jpg,jpeg to webp using image-cli-tools	2024-02-03 07:38:57 -06:00
.env.example	fix submodules & api url	2021-12-23 01:53:13 +11:00
.gitattributes	LF fix.	2023-01-24 09:58:28 +01:00
.gitignore	updates to various pages (#487 )	2022-11-02 09:31:54 +11:00
.gitmodules	Update nightly CI & remove protobufs submodule	2023-01-18 22:47:52 +10:00
.npmrc	Docusaurus 3.0 version bump	2023-08-06 19:01:29 +10:00
biome.json	bump deps	2024-01-09 01:17:34 +10:00
docusaurus.config.js	enforce trailing slash in docusaurus	2024-02-07 09:25:46 -06:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	bump deps	2024-01-09 01:17:34 +10:00
pnpm-lock.yaml	bump deps	2024-01-09 01:17:34 +10:00
README.md	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
sidebars.js	use rome as linter & formatter	2023-05-12 11:45:34 +10:00
tailwind.config.ts	Fix formatting	2023-09-11 22:46:36 +10:00
tsconfig.json	linter fixes	2023-05-17 14:25:23 +10:00
vercel.json	MQTT subpage path forwrading	2024-02-08 10:04:04 -08:00

README.md

Meshtastic

Overview

Website and documentation source for the Meshtastic project.

Stats

Development & Building

nodejs is required in your dev. environment. The method for installing nodejs depends on your operating system. This software is built using Docusaurus.

Go to the root directory of your repository and install dependencies:

pnpm install

Build the project with the following command

pnpm build

Start a local dev. instance with the following command

pnpm start