-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated blogs and added authors to yaml file (#258)
- Loading branch information
Showing
23 changed files
with
7,138 additions
and
4,650 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,64 +1,30 @@ | ||
# CIROH Documentation Site | ||
|
||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
Welcome to CIROH's Documentation Site! This site provides all the information you need to understand and contribute to our projects. | ||
|
||
## Introduction | ||
|
||
## How to Get Started? | ||
|
||
Go to "https://ciroh-ua.github.io/" or "docs.ciroh.org" | ||
|
||
- Click on Documentation or any tab. | ||
- Click on Edit page at the bottom of the page for adding new content. | ||
- Create a Pull Request. | ||
- Changes will be reviewed and merged by admin. | ||
|
||
Support Email: [email protected] | ||
|
||
========================================= | ||
|
||
### Installation | ||
|
||
1. Download and Install node js LTS version from https://nodejs.org/en if not already installed. | ||
|
||
2. How to build and run this project locally. | ||
This website is built using [Docusaurus](https://docusaurus.io/), a tool that helps create simple and effective documentation websites. | ||
|
||
``` | ||
npm install | ||
npm run build | ||
npm run start | ||
``` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ npm run 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 | ||
|
||
``` | ||
$ npm run build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
## How to Get Started? | ||
|
||
### Deployment | ||
Visit our site at [docs.ciroh.org](https://ciroh-ua.github.io/). | ||
|
||
To deploy the website, we need to compile this project to deployable package. | ||
### How to Contribute | ||
|
||
``` | ||
$ npm run build | ||
``` | ||
1. **Browse the Documentation**: Click on the "Documentation" tab or any other tab to explore the content. | ||
2. **Edit Content**: See something that needs to be updated? Click on the "Edit page" button at the bottom of the page. | ||
3. **Submit Changes**: Make your edits and create a Pull Request. Your changes will be reviewed and merged by the admin. | ||
|
||
above command will create **build** directory in your project folder. We can now deploy the content of that directory to the web server. | ||
If you need help, please contact us at [[email protected]](mailto:[email protected]). | ||
|
||
### Cheatsheet | ||
## Installation | ||
|
||
- [markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) | ||
- [tina.io](https://tina.io/) | ||
- [Infima](https://infima.dev/docs/getting-started/introduction) | ||
To set up the project locally, follow these steps: | ||
|
||
### Contributors | ||
- Arpita Patel ([email protected]) | ||
1. **Install Node.js**: Download and install the LTS version from [nodejs.org](https://nodejs.org/en) if you don't have it already. | ||
2. **Build and Run Locally**: | ||
```bash | ||
npm install | ||
npm run build | ||
npm run start |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.