Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/privatepuffin/truecharts-docs-lite-version


https://github.com/privatepuffin/truecharts-docs-lite-version

Last synced: about 9 hours ago
JSON representation

Awesome Lists containing this project

README

        

# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

```bash
$ yarn
```

### Local Development

```bash
$ 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

```bash
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

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

Not using SSH:

```bash
$ 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.

### Contributing

> The docs in the website for [truecharts/charts](https://github.com/truecharts/charts) are built from the charts repo.
> Please submit PR's for improvements to the docs at [truecharts/charts](https://github.com/truecharts/charts), as we cannot merge them here!
> Thank you!