CueSync

CueSync is a JavaScript library designed to simplify the integration of interactive transcripts into multimedia content.

Table of contents

• Installation
• Examples
• Specs
• Bugs and feature requests
• Documentation
• Contributing
• Creator

Installation

https://cuesync.github.io/1.0/installation

Examples

https://cuesync.github.io/1.0/examples

Specs

https://cuesync.github.io/1.0/specs

Bugs and feature requests

Have a bug or a feature request? Please read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

CueSync's documentation, included in this repo in the root directory, is built with Hugo and publicly hosted on GitHub Pages at https://cuesync.github.io/. The docs may also be run locally.

Running documentation locally

1. Run npm install to install the Node.js dependencies, including Hugo (the site builder).
2. From the root /cuesync.github.io directory, run npm run docs-serve in the command line.
3. Open http://localhost:9001/ in your browser, and voilà.

Learn more about using Hugo by reading its documentation.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Creator

Neeraj Kumar Das

• https://github.com/nkdas91
• https://neerajdas.com/