https://github.com/hieupham2000/hustpvo-documentation
User manual website for my engineering graduation project, containing instructions from overview to detail, with images and videos
https://github.com/hieupham2000/hustpvo-documentation
deploy docusaurus2 github-actions github-pages
Last synced: about 1 year ago
JSON representation
User manual website for my engineering graduation project, containing instructions from overview to detail, with images and videos
- Host: GitHub
- URL: https://github.com/hieupham2000/hustpvo-documentation
- Owner: HieuPham2000
- Created: 2023-07-08T04:03:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T16:14:26.000Z (almost 3 years ago)
- Last Synced: 2025-01-13T14:29:28.208Z (over 1 year ago)
- Topics: deploy, docusaurus2, github-actions, github-pages
- Language: JavaScript
- Homepage: https://hieupham2000.github.io/HUSTPVO-documentation/
- Size: 8.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
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.