Reademes updated with new banner

Notice board added
This commit is contained in:
Kingkor Roy Tirtho
2022-07-13 10:11:02 +06:00
parent 115b9e5f5d
commit 2a75aefb0f
5 changed files with 19 additions and 49 deletions
+2 -40
View File
@@ -1,41 +1,3 @@
# Website
# Docs for Fl-Query
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=<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.
This documentation is based on Docusaurus2 & React