mirror of
https://github.com/pseXperiments/icicle.git
synced 2026-04-18 03:00:06 -04:00
40309329fb
migrate docs website + improved docs (#389) * Update README.md (#385) * refactor * refactor * refactor * rename task * update codespell * multi gpu docs (#391) * Refactor * refacotr * fix typo * Apply suggestions from code review * refactor * refactor --------- Co-authored-by: ImmanuelSegol <3ditds@gmail.com> Co-authored-by: DmytroTym <dmytrotym1@gmail.com> Co-authored-by: ChickenLover <Romangg81@gmail.com>
40 lines
646 B
Markdown
40 lines
646 B
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
|
|
### Installation
|
|
|
|
```
|
|
$ npm i
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```
|
|
$ npm 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
|
|
|
|
```
|
|
$ npm run build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
### Deployment
|
|
|
|
Using SSH:
|
|
|
|
```
|
|
$ USE_SSH=true npm run deploy
|
|
```
|
|
|
|
Not using SSH:
|
|
|
|
```
|
|
$ GIT_USER=<Your GitHub username> npm run deploy
|
|
```
|