Skip to content

Commit

Permalink
add github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
SushilMallRC committed Apr 10, 2024
1 parent 69a58fe commit 4744498
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/release-github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: GitHub Pages release
on:
push:
branches:
- master
- addGitHubPages
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version}}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
4 changes: 4 additions & 0 deletions docs/app-registration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

# Registering your application

Before you begin development, you will first need to register your application via the RingCentral Developer Console. This step will provision your application a unique set of credentials used to identify your application on the network, and comes with the benefits listed below.
14 changes: 14 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Home

[![Build Status](https://github.com/ringcentral/ringcentral-js/workflows/CI%20Pipeline/badge.svg?branch=master)](https://github.com/ringcentral/ringcentral-js/actions)
[![Coverage Status](https://coveralls.io/repos/github/ringcentral/ringcentral-js/badge.svg?branch=master)](https://coveralls.io/github/ringcentral/ringcentral-js)
[![Chat](https://img.shields.io/badge/chat-on%20glip-orange.svg)](https://ringcentral.github.io/join-ringcentral/)
[![Twitter](https://img.shields.io/twitter/follow/ringcentraldevs.svg?style=social&label=follow)](https://twitter.com/RingCentralDevs)

The RingCentral Javascript SDK allows developers building client and server-side javascript applications to interface with the following RingCentral APIs more easily:

* [Voice](https://developer.ringcentral.com/api-products/voice)
* [Messaging](https://developer.ringcentral.com/api-products/sms), e.g. Fax, SMS, voicemail, etc.
* [Glip Team Messaging](https://developer.ringcentral.com/api-products/team-messaging)
* [Call Management](https://developer.ringcentral.com/api-products/configuration)
* [Meetings](https://developers.ringcentral.com/api-products/meetings)
41 changes: 41 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
site_name: RingCentral Javascript SDK
theme:
name: material
features:
- navigation.path
- navigation.tabs
- navigation.top
- navigation.expand
- navigation.sections
- search.sharing
- search.highlight
- content.code.copy
- content.action.edit
- content.action.view
- content.code.annotate
palette:
- scheme: default
primary: custom
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono

plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- badges
- social
- exclude:
regex:
- '^\.#.*'
- '.*\.\#.*$'

0 comments on commit 4744498

Please sign in to comment.