feat: Add docs package which uses docusaurus internally

This commit is contained in:
Faruk AYDIN
2021-12-09 17:11:01 +01:00
committed by Ömer Faruk Aydın
parent 95d38b740e
commit cab2d281f3
43 changed files with 5777 additions and 86 deletions

33
packages/docs/README.md Normal file
View File

@@ -0,0 +1,33 @@
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens 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.