mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
meshtastic/website
History
apt105 92628c1ce6 rename folder
2021-05-01 18:54:39 +01:00
..
docs Device pages 2021-05-01 18:51:51 +01:00
src More restructuring, Update landing page 2021-04-11 21:03:19 +10:00
static rename folder 2021-05-01 18:54:39 +01:00
babel.config.js Add docusaurus site 2021-04-02 11:34:44 +11:00
docusaurus.config.js Enable DocSearch 2021-04-21 17:59:45 +10:00
package.json Add PR checking action, update Docusaurus 2021-04-30 17:48:33 +10: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 Device pages 2021-05-01 18:51:51 +01:00
tsconfig.json Add docusaurus site 2021-04-02 11:34:44 +11:00
yarn.lock Add PR checking action, update Docusaurus 2021-04-30 17:48:33 +10: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.