mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-28 06:59:45 -08:00

Meshtastic project website and documentation

Find a file

rcarteraz 0197ccde19 Merge pull request #649 from tomuk5/patch-1 Update index.mdx - T-Beam Supreme and S3 Module		2023-07-28 16:05:23 -07:00
.github	Update nightly CI & remove protobufs submodule	2023-01-18 22:47:52 +10:00
.trunk	use rome as linter & formatter	2023-05-12 11:45:34 +10:00
.vscode	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
docs	fix image file type	2023-07-28 16:01:44 -07:00
src	remove all traces of gui flasher	2023-06-28 22:02:20 -07:00
static	Merge branch 'master' into patch-1	2023-07-28 15:45:50 -07: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
docusaurus.config.js	use rome as linter & formatter	2023-05-12 11:45:34 +10:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	linter fixes	2023-05-17 14:25:23 +10:00
pnpm-lock.yaml	linter fixes	2023-05-17 14:25:23 +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	use rome as linter & formatter	2023-05-12 11:45:34 +10:00
tsconfig.json	linter fixes	2023-05-17 14:25:23 +10: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