tednakamura / webrtc-org

WebRTC.org website

The webrtc.org website

This is the repo for webrtc.org, home of the WebRTC project.

For more information about WebRTC, we maintain a list of WebRTC Resources. If you've never worked with WebRTC, we recommend you start with the 2013 Google I/O WebRTC presentation.

We welcome corrections, updates and additions!

See CONTRIBUTING for instructions. All contributors must sign a contributor license agreement before code can be accepted. Please complete the agreement for an individual or a corporation as appropriate.

Add or edit content

The webrtc.org site is built from Markdown files, using the Jekyll tool.

The default branch for the webrtc.org repo is gh-pages.

We recommend that you build and run the site locally in order to check your work: see the instructions below.

You can also review your changes (after you've pushed them) on the GitHub Pages site for your fork. For example, if your username is foobar and you edited the Contributing Fixes page, you can view your updated version online at foobar.github.io/webrtc-org/contributing. A GitHub Pages site is automatically generated by GitHub for every repo that has a gh-pages fork.

Where are the files?

Each page on the site corresponds to an index.md file in a directory of the repository's gh-pages branch. For example, the Development page at webrtc.org/native-code/development corresponds to github.com/webrtc/webrtc-org/tree/gh-pages/native-code/development/index.md.

The top navigation menu items are defined in _includes/topnav.html.

To simplify URLs, many pages are at the top level of the site rather than in a subdirectory. For example, the Release Notes page linked to from the site's About menu is at webrtc.org/release-notes, and the corresponding Markdown file is release-notes/index.md.

Make a correction or update

For minor code changes, fork the repo and make a pull request from your GitHub account.

For major or ongoing changes, create a branch and issue pull requests from that. Please delete the branch once you’ve finished working on it.

Find out more in our Developer's Guide.

Add a new page

1. Create a new directory in your local repo, either at the top level of the site or in an existing directory.

2. Copy an existing index.md file into the new directory you created.

3. At the start of the new index.md file, adjust the YAML front matter that is used by the Jekyll build tool. For example, the following front matter will cause Jekyll to create a page with the title Android at webrtc.org/native-code/android/index.html:

    ---
    layout: default
    title: Android
    permalink: /native-code/android/
    ---
   

4. Edit the content of index.md: files are in Markdown format.

   Images are added with markup like the following example (from the Architecture page):

    ![]({{ site.baseurl }}/assets/images/webrtc-public-diagram-for-website.png)
   

   Add code snippets like this:

    ~~~~~ bash
    export JAVA_HOME=<location of OpenJDK 7>
    ~~~~~
   

5. Commit and push your work.

6. Review your changes locally or from the GitHub Pages site for your fork (for example, usename.github.io/webrtc-org).

7. Make a pull request.

Build and run the site locally

1. If necessary, install Ruby.

2. Navigate to your webrtc-org repo directory.

3. Run the following command:

    bundle exec jekyll serve
   

   HTML files are generated in the _site directory and regenerated automatically when you make changes.

4. View the site in a browser at http://0.0.0.0:4000/webrtc-org.

More information is available from Using Jekyll With Pages (but do not run the Setting up Jekyll step!)