mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-27 14:39:54 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
meshtastic/website
History
Joar Svensson 74428b9a1b Improve documentation
2021-10-26 21:09:34 +02:00
..
docs Improve documentation 2021-10-26 21:09:34 +02:00
src Update dependencies and config 2021-10-23 13:35:13 +11:00
static Clarification, added permissions note/video 2021-10-23 12:44:51 -06:00
babel.config.js Add docusaurus site 2021-04-02 11:34:44 +11:00
docusaurus.config.js Update dependencies and config 2021-10-23 13:35:13 +11:00
package.json Update dependencies and config 2021-10-23 13:35:13 +11:00
protobuf.tmpl Add docusaurus site 2021-04-02 11:34:44 +11:00
README.md Add docusaurus site 2021-04-02 11:34:44 +11:00
sidebars.js Merge branch 'meshtastic:master' into Go 2021-07-17 20:54:49 +01:00
tsconfig.json Add docusaurus site 2021-04-02 11:34:44 +11:00
yarn.lock Update dependencies and config 2021-10-23 13:35:13 +11:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.