Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/storiesjs/website

Website for Stories
https://github.com/storiesjs/website

angular ember frontend javascript react react-native ssr stories storiesjs svelte vue

Last synced: 8 days ago
JSON representation

Website for Stories

Awesome Lists containing this project

README

        

# Stories Web Site
Is a web site for [Stories](https://storiesjs.org). It 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

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER= 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.

## License

[GNU General Public License v2.0](https://github.com/storiesjs/stories/blob/main/LICENSE)