Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: replace use of tsdocs.dev by typedoc generated markdown #30

Merged
merged 11 commits into from
Feb 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion .markdownlintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
/node_modules/
# Copied from .prettierignore

CHANGELOG.md

# Copied from .eslintignore

## External dependencies
/ext/

# Copied from .gitignore

## editors
/.idea
/.vscode

## system files
.DS_Store

## npm
/node_modules/
/npm-debug.log

## temp folders
/.tmp/

## dist
/dist/
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Copy any changes made here to .markdownlintignore

CHANGELOG.md

# Copied from .eslintignore
Expand Down
12 changes: 7 additions & 5 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
* Bridge for communicating between a Livery Video Player and the interactive layer page shown within that.
*
* Exports:
*
* - Class {@link InteractiveBridge} enables a Livery interactive layer element or page to communicate with
* the surrounding Livery Player
* - Element: {@link LiveryBridgeLog} logs messages posted to specified bridge or the window
* - Types: {@link Orientation}, {@link StreamPhase} are used throughout the package
* - Variable: {@link version} specifies the version of this package
* - Element {@link LiveryBridgeLog} logs messages posted to specified bridge or the window
* - Types {@link Orientation} and {@link StreamPhase} are used throughout the package
* - Variable {@link version} specifies the version of this package
* - Class {@link AbstractPlayerBridge} is used by LiveryPlayer for the `PlayerBridge` implementation
* (in the past: {@link LiveryBridge})
* - Class {@link MockPlayerBridge} is a player bridge that returns mock data for testing
* - Element {@link LiveryBridgeMock} mocks a LiveryPlayer with an interactive child element or iframe for testing
* - Element {@link LiveryBridgeInteractive} is an interactive element that enables testing all interactive commands
*
* **Note:** If you are reading this at tsdocs.dev we recommend you to disable the `Inherited`
* member visibility from `Settings` to make it easier to find our members.
* **Note:** When using the UMD bundle, the exports can be found as properties of `livery` in the global namespace,
* e.g: `livery.version`.
*
* @packageDocumentation
*/
Expand All @@ -40,6 +41,7 @@ export type {
PlaybackMode,
PlaybackState,
Qualities,
Quality,
StreamPhase,
UserFeedback,
Volume,
Expand Down
Loading
Loading