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

Meshtastic project website and documentation

Find a file

Foster Irwin 2538739fdd Update flashing-esp32.mdx		2022-05-27 16:00:21 -06:00
.github	Fix CI	2022-03-09 23:39:47 +11:00
docs	Update flashing-esp32.mdx	2022-05-27 16:00:21 -06:00
protobufs@e7791c33fd	Update protobuf submodule	2022-05-27 18:44:44 +00:00
src	Merge pull request #331 from jfirwin/getting-started	2022-05-10 09:58:49 -06:00
static	Add nano g1 and small fixes to other hardware pages	2022-05-06 21:21:34 +01:00
.env.example	fix submodules & api url	2021-12-23 01:53:13 +11:00
.eslintrc.cjs	Hardware pages (#299 )	2022-04-02 00:34:49 +11:00
.gitignore	fix/remove-inaccurate-note (#336 )	2022-05-12 08:11:03 +10:00
.gitmodules	Fix old submodule	2022-03-09 19:11:14 +11:00
.prettierrc	Hardware pages (#299 )	2022-04-02 00:34:49 +11:00
babel.config.js	Move website to repo root	2021-12-21 22:44:01 +11:00
docusaurus.config.js	Update dependencies	2022-05-07 23:51:02 +10:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	Update dependencies	2022-05-07 23:51:02 +10:00
pnpm-lock.yaml	Update dependencies	2022-05-07 23:51:02 +10:00
protobuf.tmpl	Move website to repo root	2021-12-21 22:44:01 +11:00
README.md	Update README.md	2022-05-13 10:12:34 +10:00
sidebars.js	Update docs structure	2022-04-09 00:29:34 +10:00
tailwind.config.cjs	Hardware page improvements	2022-04-03 00:57:31 +11:00
tsconfig.json	Update dependencies	2022-05-07 23:51:02 +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