SVT Encore Documentation

Welcome to the SVT Encore documentation project. It is mainly aimed at advanced technical users, like developers.

SVT Encore is a scalable tool for video transcoding,

Online documentation

Contributions are encouraged and welcomed.

Development

Clone the project with git. Build the documentation by invoking the 'asciidoctor' goal:

foo@bar:~$./gradlew clean asciidoctor

View the generated documentation in a browser of choice, for example

foo@bar:~$firefox build/docs/asciidoc/index.html

---

Note

The online documentation (GitHub Pages) is updated when something is committed to main branch of this repo.

---

Requirements

• Gradle 7.x.x

• Optional: Intellij with the Asciidoctor Plugin

Optional for development: IntelliJ Plugin

Install the Asciidoctor plugin and get writing, with a preview window, export to HTML, PDF and more. It is great actually.

License

This documentation is

• Copyright 2021 Sveriges Television AB

and released under

Creative Commons Attribution-ShareAlike 4.0 International License

Note: The main project SVT Encore itself was initiated in 2018.

Credits

• Write The Docs and everyone driving the Docs-As-Code philosophy, thanks.

• Asciidoctor skins project

• Highlights