mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-28 15:09:46 -08:00

Meshtastic project website and documentation

Find a file

rcarteraz c6e2408988 Merge branch 'master' into jsonChannel		2024-02-12 09:03:52 -07:00
.github	fix biome errors (#977 )	2024-02-08 15:23:54 -06:00
.vscode	add MDX extension to recommended	2024-01-06 11:06:22 +10:00
docs	Merge branch 'master' into jsonChannel	2024-02-12 09:03:52 -07:00
src	Remove unused import	2024-02-10 00:16:49 -07: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	fix biome errors (#977 )	2024-02-08 15:23:54 -06:00
docusaurus.config.js	Glossary of terms page	2024-02-11 11:47:20 -06:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	Glossary of terms page	2024-02-11 11:47:20 -06:00
pnpm-lock.yaml	Glossary of terms page	2024-02-11 11:47:20 -06:00
README.md	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
sidebars.js	fix biome errors (#977 )	2024-02-08 15:23:54 -06:00
tailwind.config.ts	fix biome errors (#977 )	2024-02-08 15:23:54 -06: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