mirror of
https://github.com/teslamate-org/teslamate.git
synced 2026-01-24 21:06:08 +08:00
34 lines
806 B
Markdown
34 lines
806 B
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator and automatically deployed to [docs.teslamate.org](https://docs.teslamate.org).
|
|
|
|
### Installation
|
|
|
|
```
|
|
$ npm i
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```
|
|
$ npm 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
|
|
|
|
```
|
|
$ npm run 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 npm run 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.
|