bigbluebutton-Github/docs
Anton Georgiev 9941de982c
Create CNAME
2023-02-10 14:21:43 -05:00
..
backup Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
docs Fix broken links in the new docs. 2023-01-12 21:46:29 +01:00
src fix(docs): Make index page behave in dark mode and fix spacing 2023-02-06 17:07:17 +01:00
static Fix broken links in the new docs. 2023-01-12 21:46:29 +01:00
vagrant Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
.gitignore Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
babel.config.js Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
build.sh Fix broken links in the new docs. 2023-01-12 21:46:29 +01:00
CNAME Create CNAME 2023-02-10 14:21:43 -05:00
docusaurus.config.js Fix broken links in the new docs. 2023-01-12 21:46:29 +01:00
package-lock.json Fix broken links in the new docs. 2023-01-12 21:46:29 +01:00
package.json Fix broken links in the new docs. 2023-01-12 21:46:29 +01:00
README.md Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
sidebars.js Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
tsconfig.json Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
Vagrantfile Move bigbluebutton-docs to the main repository. 2022-12-10 21:21:56 +01:00
yarn.lock Fix broken links in the new docs. 2023-01-12 21:46:29 +01:00

Website

This website is built using Docusaurus 2, 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.