https://github.com/quran/qf-api-docs
Quran Foundation API Documentation Portal using Docusaurus
https://github.com/quran/qf-api-docs
Last synced: 30 days ago
JSON representation
Quran Foundation API Documentation Portal using Docusaurus
- Host: GitHub
- URL: https://github.com/quran/qf-api-docs
- Owner: quran
- Created: 2023-08-27T10:50:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-30T10:32:16.000Z (about 1 month ago)
- Last Synced: 2025-05-03T21:59:37.869Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://api-docs.quran.foundation/
- Size: 10.8 MB
- Stars: 10
- Watchers: 5
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](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= 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.