https://github.com/slorber/docusaurus-starter

https://github.com/slorber/docusaurus-starter

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/slorber/docusaurus-starter
• Owner: slorber
• Created: 2021-07-22T14:36:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-13T14:54:16.000Z (3 months ago)
• Last Synced: 2024-10-04T02:41:19.872Z (about 1 month ago)
• Language: JavaScript
• Size: 1.65 MB
• Stars: 1
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This website is built using [Docusaurus](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.