Snigdha-OS/documentation
2
0
Fork 0
mirror of https://github.com/Snigdha-OS/documentation.git synced 2025-09-06 19:15:12 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
Eshan Roy
2024-03-26 14:59:58 +05:30
parent 9a38556af2
commit e67b1a08ed
1 changed files with 0 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -1,44 +1,2 @@
[![pages-build-deployment](https://github.com/Snigdha-OS/documentation/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/Snigdha-OS/documentation/actions/workflows/pages/pages-build-deployment)
[![Deploy to GitHub Pages](https://github.com/Snigdha-OS/documentation/actions/workflows/deploy.yml/badge.svg?branch=master)](https://github.com/Snigdha-OS/documentation/actions/workflows/deploy.yml)
# 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=<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.