Snigdha-OS/snigdhaos-devdocs
2
0
Fork 0
mirror of https://github.com/Snigdha-OS/snigdhaos-devdocs.git synced 2025-09-08 15:24:55 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 docs: update dev guides

Browse Source
This commit is contained in:
RiO
2024-12-23 23:38:41 +05:30
parent 0531d1c44d
commit 1eccabd382
1 changed files with 51 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@@ -1,41 +1,77 @@
# Website # 🌐 Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
### 📦 Installation
To get started, install the necessary dependencies using `pnpm` and clone the repository:
``` ```
$ pnpm install git clone https://github.com/Snigdha-OS/DevContrib.git
cd DevContrib
pnpm install
``` ```
### Local Development
### 🚀 Local Development
To start a local development server, run the following command:
``` ```
$ pnpm start pnpm 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. This command starts a local server and opens a browser window. Most changes are reflected live without the need to restart the server. 👨‍💻
### Build
### 🛠️ Build
To generate static content and prepare for deployment, use the following command:
``` ```
$ pnpm build pnpm build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This will generate static content into the `build` directory, which can be served using any static hosting service. 🌍
### Deployment
Using SSH:
### 🚢 Deployment
#### Using SSH:
If you are using SSH to deploy, run:
``` ```
$ USE_SSH=true yarn deploy USE_SSH=true pnpm deploy
``` ```
Not using SSH: #### Without SSH:
If you're not using SSH, you can deploy by specifying your GitHub username:
``` ```
$ GIT_USER=<Your GitHub username> yarn deploy GIT_USER=<Your GitHub username> pnpm 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. If you are using **GitHub Pages** for hosting, this command is a convenient way to build the website and push it to the `gh-pages` branch. 📦💻
### 👨‍💻 Developer
This project is developed and maintained by **d3v1l0n**. 🧑‍💻
🔧 **Technologies Used:**
- Docusaurus
- pnpm
- GitHub Pages
Happy coding! 🎉