BigBlueButton/bigbluebutton-Github
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source 
This commit updates the readme to the latest changes.

closes #16666
This commit is contained in:
timo 2023-02-09 11:41:39 +01:00
parent e4b9637eef
commit f00cebb1b6
1 changed files with 21 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/README.md
View File

@ -1,41 +1,36 @@
# Website
# BigBlueButton Docs
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
These docs are automatically built using [Docusaurus 2](https://docusaurus.io/)
and GitHub Actions (see [deploy-docs.yml](../.github/workflows/deploy-docs.yml)).
### Installation
## Local Development
To test build the docs locally you can either use `yarn` or `npm`.
```
$ yarn
$ yarn install # install docusaurus and dependencies
$ ./build.sh # add all versions to build
$ yarn start # start local dev server
```
### Local Development
The script `build.sh` goes through all branches of the repository and adds all
release branches that have a `docusaurus.config.js`-file as versions to the docs.
Note that you can not have uncommited local changes before you run `/build.sh`,
otherwise git will refuse to change branches.
This step is optional and if you don't run it docusaurus will only build the
currently checkout out version.
```
$ yarn start
```
The last 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 development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
If you only want to build the docs you can run:
```
$ 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 command generates static content into the `build` directory
and can be served using any static contents hosting service.