/openvidu.io-docs

OpenVidu Documentation

Primary LanguageCSSApache License 2.0Apache-2.0

OpenVidu documentation is generated with MkDocs and hosted in Read the Docs.

You can edit any page or add a new one with a simple text using the Markdown format.

How to edit OpenVidu documentation

  • Clone this repository
git clone https://github.com/OpenVidu/openvidu.io-docs
  • cd into /docs folder.
  • Create a new Markdown file (.md) into an existent folder. You can create a new document category creating a new folder. The folder name will be category name. You will have to update mkdocs.yml file adding a new element as a nav child if you want to link your new file from the navigation menu.
  • Edit that file and add content in Markdown format.
  • In order to preview the documentation, you will need Python 3 and Mkdocs:
# Python 3
sudo apt-get update && sudo apt-get -y upgrade
sudo apt install -y python3-pip
# Latest Mkdocs
sudo pip3 install mkdocs==1.1

Then run the following command in the root of the project openvidu.io-docs/.

mkdocs serve

You will have the documentation available in http://localhost:8000.