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

Sacha Weatherstone f4b1767bf6 Merge pull request #830 from pdxlocations/rename-and-redirect Rename Directories and Add Redirects		2023-10-02 17:57:12 +11:00
.github	Update nightly CI & remove protobufs submodule	2023-01-18 22:47:52 +10:00
.trunk	Removal of legacy code	2023-09-09 22:16:14 +10:00
.vscode	how'd that happen?	2023-09-19 21:46:49 -07:00
docs	trunk-ignore	2023-09-28 21:40:08 -07:00
src	trunk	2023-09-18 22:07:52 -07:00
static	smaller image	2023-09-25 17:17:53 -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
.npmrc	Docusaurus 3.0 version bump	2023-08-06 19:01:29 +10:00
docusaurus.config.js	goodby to 2.0 banner	2023-08-26 11:17:14 -07:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	Fix formatting	2023-09-11 22:46:36 +10:00
pnpm-lock.yaml	Fix formatting	2023-09-11 22:46:36 +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	fix settings redirect	2023-09-28 20:09:42 -07: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