Git Product home page Git Product logo

videosdk-docs's Introduction


Video SDK Documentation
docs.videosdk.live

Website

This website is built using Docusaurus 2, a modern static website generator.

Built With

Getting Started

This section describes how you can setup our documentation on your machine.

Prerequisites

Installation

  1. Clone the repo
git clone https://github.com/videosdk-live/videosdk-docs.git
  1. Install NPM packages
npm install
  1. Run the app
npm run dev

Usage

Writing Documentation

To just edit older documentation, go to the specified versioned folder for a section, for example, you want to edit documentation for React SDK v0.25.x, open up react_versioned_docs/version-0.25.x and edit the required files there.

For updating documentation, go to specific SDK folder, for example, you want to change documentation for JS SDK so you have to open react_versioned_docs/version-0.25.x After opening this, you may seen below folder structure

   javascript_docs_versioned_docs/version-0.0.x
   ├── api
        ├── sdk-reference
   ├── guide
        ├── video-and-audio-calling-api-sdk
   .     .

If you want to modify the sdk-reference of JS SDK, you have to open up api/sdk-reference and make changes accordingly or want to modify the Guide of JS SDK, you have to open up guide/video-and-audio-calling-api-sdk and make changes accordingly.

videosdk-docs's People

Contributors

abhibhathela avatar ahmedbhesaniya97 avatar ajpaw avatar arjun-kava avatar bhavi1017 avatar bhumisalat avatar chintanrajpara avatar hdmodha avatar ishabodiwala avatar milan-48 avatar mrsurana avatar parthasondariya avatar rajansurani avatar witaka avatar yash-chudasama avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.