https://github.com/svt/encore-doc
Documentation for the SVT Encore Project
https://github.com/svt/encore-doc
documentation encore transcoding
Last synced: 10 months ago
JSON representation
Documentation for the SVT Encore Project
- Host: GitHub
- URL: https://github.com/svt/encore-doc
- Owner: svt
- License: cc-by-sa-4.0
- Created: 2021-04-26T21:38:29.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-11-24T06:21:27.000Z (over 4 years ago)
- Last Synced: 2025-07-05T15:41:38.202Z (12 months ago)
- Topics: documentation, encore, transcoding
- Language: CSS
- Homepage:
- Size: 3.61 MB
- Stars: 2
- Watchers: 6
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SVT Encore Documentation
[](https://creativecommons.org/licenses/by-sa/4.0/)
[](https://api.reuse.software/info/github.com/svt/encore-doc)
Welcome to the [SVT Encore](https://github.com/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](https://svt.github.io/encore-doc/)
Contributions are encouraged and welcomed.
## Development
Clone the project with git.
Build the documentation by invoking the 'asciidoctor' goal:
```console
foo@bar:~$./gradlew clean asciidoctor
```
View the generated documentation in a browser of choice, for example
```console
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](https://plugins.jetbrains.com/plugin/7391-asciidoc) 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](https://www.writethedocs.org/) and everyone driving the Docs-As-Code philosophy, thanks.
- [Asciidoctor skins project](https://github.com/darshandsoni/asciidoctor-skins)
- [Highlights](https://highlightjs.org/)