https://github.com/xframes-project/xframes-website
Docusaurus-based website source of xframes.dev
https://github.com/xframes-project/xframes-website
Last synced: 3 months ago
JSON representation
Docusaurus-based website source of xframes.dev
- Host: GitHub
- URL: https://github.com/xframes-project/xframes-website
- Owner: xframes-project
- Created: 2024-10-31T18:48:19.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-01-29T09:50:46.000Z (5 months ago)
- Last Synced: 2025-03-28T18:07:24.120Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
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.