https://github.com/pkeffect/pkeffect.github.io
Knowledge Documentation
https://github.com/pkeffect/pkeffect.github.io
Last synced: 5 months ago
JSON representation
Knowledge Documentation
- Host: GitHub
- URL: https://github.com/pkeffect/pkeffect.github.io
- Owner: pkeffect
- License: mit
- Created: 2025-02-09T21:05:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-30T23:59:26.000Z (about 1 year ago)
- Last Synced: 2025-03-31T00:25:25.047Z (about 1 year ago)
- Language: TypeScript
- Size: 20.4 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.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.