Jsdoc has the `@link` syntax for links, but github's markdown renderer
sees the closing curly brace as part of the link.
To format things in a way that works for both jsdoc and github, we
should specify text for the `@link` as well as the link itself. This
separates the URL from the enclosing curly braces in a way that fixes
github's rendering of the markdown.
Change-Id: I1cb9273aae50d6089aa4d3c33a7ad5daecaa141f
Originally, docs were slow to build, and many people did not need a
local copy. Now, building the docs is fast, and doing everything as
part of "all" is less surprising.
Closes#1421
Change-Id: I5ac254df9d2beca8c1c5898614782a81e662a0e9
This adds a new script which should simplify the process of installing
prereqs on Debian and Ubuntu-based Linux distributions. This also
updates the required versions of NodeJS and Git.
Closes#1175
Change-Id: If298cc46650bfd0ebe726c8fa3184dd0d063bfaf
README.md duplicated some information from welcome.md, included other
details better left to welcome.md, and did not provide clear enough
information about support and features.
This moves some parts of README.md to welcome.md, drops others, adds
some details about feature set, and reformats some of the existing
support information into tables.
Change-Id: Ic863bc47fd46d01ca57d126654b2c9902a4b17bb
NPM released a new version which no longer work with the version
of Node we install in the docs. By updating NPM and Node they
play nicely with each other and no longer need the symlink.
Tested on a clean VM using:
Distributor ID: Ubuntu
Description: Ubuntu 14.04.5 LTS
Release: 14.04
Codename: trusty
Change-Id: Ie4a2cce194944ea57b542b01d072dfff8a8b40b3
- Add prereqs section
- Add architecture diagrams
- Adjust doc margins
- Change some wording and fix typos
- Convert alert() to console.error() in basic usage tutorial
- Expand prose in debugging tutorial
- Add comments about asynchronous methods
- Expand description of Closure base
- Change some links to source rather than API docs
- Clarify some vague language
- Refactor some of the plugin text
Modified jsdoc to add a new 'linksource' tag to link directly to the
source code for an entity.
Change-Id: I6b879050fc59917ce98954a4fabd8afca60af456
- Update tutorial link in README
- Fix python version in README
- Move jsdoc conf to docs/ folder
- Add API docs main page
- Change style of inline code blocks
- Don't repeat tutorial title in jsdoc template
- (makes it easier to read tutorials on github as MD)
- Add tutorials for:
- Welcome to Shaka
- Basic Usage
- Debugging
- Configuration
- Networking and Buffering Configuration
- DRM Configuration
- License Server Authentication
- Plugins
- Tutorials still to come:
- License Headers and Track Restrictions
- Special Considerations for Live
- v2 Upgrade Guide
Change-Id: I16401c216cf4023d9097750ac7f6090c68bf3c9b
Joey Parrish
Aaron Vaage