https://github.com/shellhub-io/docs

:book: ShellHub documentation
https://github.com/shellhub-io/docs

Last synced: 3 days ago
JSON representation

:book: ShellHub documentation

• Host: GitHub
• URL: https://github.com/shellhub-io/docs
• Owner: shellhub-io
• Created: 2022-07-20T13:22:10.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-05T20:01:06.000Z (7 days ago)
• Last Synced: 2024-11-05T21:17:35.888Z (7 days ago)
• Language: JavaScript
• Homepage: https://docs.shellhub.io
• Size: 4.06 MB
• Stars: 8
• Watchers: 4
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

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.