https://github.com/hyperse-io/docusaurus-starter
The hyperse-io documents, blogs website
https://github.com/hyperse-io/docusaurus-starter
docusaurus-starter hyperse
Last synced: about 2 months ago
JSON representation
The hyperse-io documents, blogs website
- Host: GitHub
- URL: https://github.com/hyperse-io/docusaurus-starter
- Owner: hyperse-io
- License: mit
- Created: 2024-05-26T02:34:29.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-08-05T07:47:57.000Z (10 months ago)
- Last Synced: 2024-09-10T15:59:56.006Z (9 months ago)
- Topics: docusaurus-starter, hyperse
- Language: TypeScript
- Homepage: https://hyperse-io.github.io/docusaurus-starter
- Size: 25.4 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 3](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.
### examples cases
[gh-pages-starter] https://github.com/hyperse-io/gh-pages-starter