fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-13 05:40:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme; basic changes

Browse source
This commit is contained in:
Owen 2025-02-27 10:29:05 -05:00
parent 75ded0b2a8
commit 9459924f92
No known key found for this signature in database
GPG key ID: 8271FDFFD9E0CCBD
1 changed files with 4 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -5,41 +5,26 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
### Installation
```
$ yarn
$ npm i
```
### Local Development
```
$ yarn start
$ cd packages/docusaurus/
$ npm run dev
```
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
$ npx sst deploy --stage prod
```
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.
# License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.