alecodes/mini-strap
2
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages 2 Wiki Activity Actions

chore(website): migrate from docosaurus to zola SSG

Browse source
This commit is contained in:
Alexander Navarro 2024-12-23 11:16:33 -03:00
parent 13679f77ca
commit 7e8dc4ec5a
49 changed files with 341 additions and 1523 deletions
Download patch file Download diff file Expand all files Collapse all files

42
packages/website/README.md
View file

@ -1,41 +1,15 @@
# Website
# website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
To install dependencies:
### Installation
```
$ yarn
```bash
bun install
```
### Local Development
To run:
```
$ yarn start
```bash
bun run index.ts
```
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=<Your GitHub username> 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.
This project was created using `bun init` in bun v1.1.40. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.