Code Monkey home page Code Monkey logo

docs's Introduction

Video.js Documentation

This repository is the home of the Video.js Docs

This repo contains a grunt process that clones the video.js repo and generates the documentation:

  • Guides are copied and converted from markdown to html
  • Examples are copied
  • API docs are generated from the video.js source code comments

Information on the grunt process

  • Dependencies: in the top level directory, run: npm install

View the package to see what the dependencies are.

  • The plugins are the standard JSDoc plugins EXCEPT commentsOnly.js. This creates the files from which the docs are actually built. The plugin has been modified to leave blank lines where actual code exists in the source instead of removing all non-comment lines.
  • The createFiles task unconditionally overwrites existing files, which is intended.
  • The Gruntfile.js can be executed by simply using grunt at the command line.

Contributing

No content is edited here. If you want to add or make corrections to the content, do that in [https://github.com/videojs/video.js] and then enter an issue here to regenerate the docs. If you want to enhance or fix the doc generation process, fork this repo and send a pull request.

Pull requests are welcome against the master branch. Merges into the gh-pages branch, from which the docs are served, will happen periodically.

docs's People

Contributors

brandonocasey avatar capncodewash avatar heff avatar mboles avatar mister-ben avatar progredior avatar rcrooks avatar sprice avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Code not rendered correctly in player example

At the top of this page: http://docs.videojs.com/docs/api/player.html

The code isn't escaped properly. It looks like:


In the following example, the data-setup attribute tells the Video.js library to create a player instance when the library is ready.

<video id="example_video_1" data-setup='{}' controls>
  <source src="my-source.mp4" type="video/mp4">
</video>

Rework Gruntfile to pull docs/examples from the video.js dist, not from video.js doc

The Gruntfile needs reworking to bring the docs/example files from the dist/docs directory of video.js (where they are designed to be part of the distribution); they depend on the built and dist-ready JavaScript and CSS files in that directory structure, and are not designed to work "out of the box" in the video.js doc directory.

Personally, I think the changes in video.js #2915 were a mistake - although they got the simple-example working on the docs.videojs.com site, they tie that example to an old version of video.js (5.0.2?!), whereas the fix should have happened in the build process here, so that index.html files work here on the doc site and in the dist, and refer to the version of video.js that they were with when they were built.

[bug] Broken links in Docs

While browsing though the docs, I found some pages link to 404s.. e.g. Videojs Options links to Components (broken) in the last paragraph.

Luckily it's just an issue of replacing .md to .html extensions in links, when pages are linking to themselves directly (meaning not from docs index)

Another places where I found broken links:

  • Setup -- link "options" in Step 2
  • Plugins -- link "Video.js API" in Step 1 paragraph

Sound off option

Would be great to have a sound off option.

Looked at the docs and GitHub without any luck.

โœŒ๏ธ

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.