https://github.com/dodoex/docs
https://github.com/dodoex/docs
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dodoex/docs
- Owner: DODOEX
- Created: 2020-07-29T03:03:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-09T04:09:27.000Z (over 1 year ago)
- Last Synced: 2024-04-14T10:14:10.929Z (about 1 year ago)
- Language: JavaScript
- Size: 62 MB
- Stars: 9
- Watchers: 6
- Forks: 42
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/DODOEX/docs/actions/workflows/main.yml)
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### 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= 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.