mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-10 07:34:11 -08:00

Meshtastic project website and documentation

Find a file

Garth Vander Houwen 8a3dedc2c0 Update index.md		2022-06-11 19:03:46 -07:00
.github	Fix CI	2022-03-09 23:39:47 +11:00
docs	Update for the public preview	2022-06-07 19:34:26 -07:00
protobufs@dbd4219a86	Update protobuf submodule	2022-06-11 13:50:07 +00:00
src	Update index.md	2022-06-11 19:03:46 -07:00
static	Rename apple-app-site-association to apple-app-site-association.txt	2022-06-11 18:31:01 -07: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