From c590e733513dc7b08c8e6a3209767ea3a4373c27 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 12 Jul 2025 23:50:21 +0000 Subject: [PATCH] deploy: da9484a4912b93353c970ed25728a9140f6a0f51 --- 404.html | 2 +- assets/js/{e0ef48a2.1ddc75d7.js => e0ef48a2.1b5927d1.js} | 2 +- .../js/{runtime~main.cdadbf17.js => runtime~main.3d485780.js} | 2 +- docs/Developers/ARCHITECTURE/index.html | 2 +- docs/Developers/contributing/index.html | 4 +++- docs/Developers/patch-notes/index.html | 2 +- docs/Developers/shell-integration-local/index.html | 2 +- docs/Developers/ui-features/index.html | 2 +- docs/Users/channels/index.html | 2 +- docs/Users/cli/index.html | 2 +- docs/Users/community-channels-unix/index.html | 2 +- docs/Users/community-channels-windows/index.html | 2 +- docs/Users/configuration/index.html | 2 +- docs/Users/installation/index.html | 2 +- docs/Users/keybindings/index.html | 2 +- docs/Users/quickstart/index.html | 2 +- docs/Users/search-patterns/index.html | 2 +- docs/Users/shell-integration/index.html | 2 +- docs/Users/showcase/index.html | 2 +- docs/Users/terminal_emulators/index.html | 2 +- docs/Users/themes/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 23 files changed, 25 insertions(+), 23 deletions(-) rename assets/js/{e0ef48a2.1ddc75d7.js => e0ef48a2.1b5927d1.js} (84%) rename assets/js/{runtime~main.cdadbf17.js => runtime~main.3d485780.js} (56%) diff --git a/404.html b/404.html index adca542..a7ce905 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ Page Not Found | Television - + diff --git a/assets/js/e0ef48a2.1ddc75d7.js b/assets/js/e0ef48a2.1b5927d1.js similarity index 84% rename from assets/js/e0ef48a2.1ddc75d7.js rename to assets/js/e0ef48a2.1b5927d1.js index 84878bf..5c042ef 100644 --- a/assets/js/e0ef48a2.1ddc75d7.js +++ b/assets/js/e0ef48a2.1b5927d1.js @@ -1 +1 @@ -"use strict";(self.webpackChunktelevision_website=self.webpackChunktelevision_website||[]).push([[7592],{1934:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"Developers/contributing","title":"Contributing","description":"First of all, thanks for considering contributing to this project. All contributions are welcome, whether they are bug reports, documentation improvements, feature requests, or pull requests.","source":"@site/../docs/02-Developers/00-contributing.md","sourceDirName":"02-Developers","slug":"/Developers/contributing","permalink":"/television/docs/Developers/contributing","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{},"sidebar":"docSidebar","previous":{"title":"Showcase","permalink":"/television/docs/Users/showcase"},"next":{"title":"Architecture Documentation","permalink":"/television/docs/Developers/ARCHITECTURE"}}');var s=t(3420),o=t(5404);const r={},l="Contributing",c={},a=[{value:"Getting started",id:"getting-started",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Forking the repository and setting up the project",id:"forking-the-repository-and-setting-up-the-project",level:3},{value:"Developing locally",id:"developing-locally",level:3},{value:"Contributing a new channel",id:"contributing-a-new-channel",level:3},{value:"Hot Topics",id:"hot-topics",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"contributing",children:"Contributing"})}),"\n",(0,s.jsx)(n.p,{children:"First of all, thanks for considering contributing to this project. All contributions are welcome, whether they are bug reports, documentation improvements, feature requests, or pull requests."}),"\n",(0,s.jsxs)(n.p,{children:["If you're not sure where to start, take a look at the ",(0,s.jsx)(n.a,{href:"#hot-topics",children:"Hot Topics"})," section for some ideas on what you could work on."]}),"\n",(0,s.jsx)(n.h1,{id:"contributing-to-televisions-documentation-website",children:"Contributing to television's documentation website"}),"\n",(0,s.jsxs)(n.p,{children:["To contribute to the docs, please refer to ",(0,s.jsx)(n.a,{href:"https://github.com/alexpasmantier/television/blob/main/website/CONTRIBUTING.md",children:"Contributing to docs"}),". This will guide you through the process of setting up the documentation environment and making changes."]}),"\n",(0,s.jsx)(n.h2,{id:"getting-started",children:"Getting started"}),"\n",(0,s.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,s.jsx)(n.p,{children:"These are pretty much the only things you need to have installed on your machine to get started with contributing to this project:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["the ",(0,s.jsx)(n.a,{href:"https://www.rust-lang.org/tools/install",children:"Rust"})," toolchain installed on your machine"]}),"\n",(0,s.jsxs)(n.li,{children:["any working version of ",(0,s.jsx)(n.a,{href:"https://git-scm.com/downloads",children:"Git"})]}),"\n",(0,s.jsxs)(n.li,{children:["the ",(0,s.jsx)(n.a,{href:"https://github.com/casey/just",children:"just"})," command runner"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"forking-the-repository-and-setting-up-the-project",children:"Forking the repository and setting up the project"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["Click on the ",(0,s.jsx)(n.code,{children:"Fork"})," button at the top right corner of the repository page to create a copy of the repository to your GitHub account."]}),"\n",(0,s.jsxs)(n.li,{children:["Clone the forked repository to your local machine by running the following command in your terminal:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"git clone https://github.com//television.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Navigate to the project directory and set up the upstream remote by running the following commands:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"cd television\ngit remote add upstream https://github.com/alexpasmantier/television.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Install the project dependencies by running the following command:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just setup\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Create a new branch for your feature or bug fix:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"git checkout -b \n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Make your changes and test them locally. Predefined commands are available to make your life simpler, using them spares some time and effort:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just --list\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Once you're all set, commit them to your branch:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:'git add .\ngit commit -m "Your commit message"\n'})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Push your changes to your forked repository:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"git push origin \n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["If not done automatically, create a pull request by navigating to the original repository and clicking on the ",(0,s.jsx)(n.code,{children:"New pull request"})," button."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"developing-locally",children:"Developing locally"}),"\n",(0,s.jsx)(n.p,{children:"Before anything else (if not done already):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just setup\n"})}),"\n",(0,s.jsx)(n.p,{children:"To run the application in debug mode while developing, with the ability to see logs and debug information:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just run\n"})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Accessing the Logs:"})}),"\n",(0,s.jsxs)(n.p,{children:["The logs are written to a file called ",(0,s.jsx)(n.code,{children:"television.log"})," in a directory that depends on your operating system / configuration:"]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Platform"}),(0,s.jsx)(n.th,{children:"Location"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Linux"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"$XDG_DATA_HOME/television/television.log"})," or ",(0,s.jsx)(n.code,{children:"$HOME/.local/share/television/television.log"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"macOS"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"$XDG_DATA_HOME/television/television.log"})," or ",(0,s.jsx)(n.code,{children:"$HOME/Library/Application\\ Support/television/television.log"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Windows"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{FOLDERID_LocalAppData}\\television\\television.log"})})]})]})]}),"\n",(0,s.jsx)(n.p,{children:"To check for linting and formatting issues (and fix them automatically), run:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just fix\n"})}),"\n",(0,s.jsx)(n.p,{children:"To get a sense of the real thing and test how your patch would behave in production, run:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just b release\n\n# or `just br`\n# or `just build release`\n"})}),"\n",(0,s.jsx)(n.p,{children:"Running the tests can be done with:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just test\n"})}),"\n",(0,s.jsx)(n.h3,{id:"contributing-a-new-channel",children:"Contributing a new channel"}),"\n",(0,s.jsx)(n.p,{children:"Contributing a new channel is pretty straightforward."}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["create a new branch, add and commit your new channel's TOML file under ",(0,s.jsx)(n.code,{children:"cable/unix"})," (or ",(0,s.jsx)(n.code,{children:"cable/windows"})," depending on your usecase)"]}),"\n",(0,s.jsx)(n.li,{children:"push your commit and create a PR"}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"hot-topics",children:"Hot Topics"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"shell integration (autocomplete, keybindings)"}),"\n",(0,s.jsx)(n.li,{children:"packaging for various linux package managers (dnf, ...)"}),"\n",(0,s.jsx)(n.li,{children:"sorting options"}),"\n",(0,s.jsx)(n.li,{children:"ansi parsing"}),"\n",(0,s.jsx)(n.li,{children:"contributing new channels"}),"\n",(0,s.jsx)(n.li,{children:"improving code documentation"}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},5404:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>l});var i=t(6672);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunktelevision_website=self.webpackChunktelevision_website||[]).push([[7592],{1934:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"Developers/contributing","title":"Contributing","description":"First of all, thanks for considering contributing to this project. All contributions are welcome, whether they are bug reports, documentation improvements, feature requests, or pull requests.","source":"@site/../docs/02-Developers/00-contributing.md","sourceDirName":"02-Developers","slug":"/Developers/contributing","permalink":"/television/docs/Developers/contributing","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{},"sidebar":"docSidebar","previous":{"title":"Showcase","permalink":"/television/docs/Users/showcase"},"next":{"title":"Architecture Documentation","permalink":"/television/docs/Developers/ARCHITECTURE"}}');var s=t(3420),o=t(5404);const r={},l="Contributing",c={},a=[{value:"Getting started",id:"getting-started",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Forking the repository and setting up the project",id:"forking-the-repository-and-setting-up-the-project",level:3},{value:"Developing locally",id:"developing-locally",level:3},{value:"Contributing a new channel",id:"contributing-a-new-channel",level:3},{value:"Hot Topics",id:"hot-topics",level:2}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"contributing",children:"Contributing"})}),"\n",(0,s.jsx)(n.p,{children:"First of all, thanks for considering contributing to this project. All contributions are welcome, whether they are bug reports, documentation improvements, feature requests, or pull requests."}),"\n",(0,s.jsxs)(n.p,{children:["If you're not sure where to start, take a look at the ",(0,s.jsx)(n.a,{href:"#hot-topics",children:"Hot Topics"})," section for some ideas on what you could work on."]}),"\n",(0,s.jsx)(n.h1,{id:"contributing-to-televisions-documentation-website",children:"Contributing to television's documentation website"}),"\n",(0,s.jsxs)(n.p,{children:["To contribute to the docs, please refer to ",(0,s.jsx)(n.a,{href:"https://github.com/alexpasmantier/television/blob/main/website/CONTRIBUTING.md",children:"Contributing to docs"}),". This will guide you through the process of setting up the documentation environment and making changes."]}),"\n",(0,s.jsx)(n.h2,{id:"getting-started",children:"Getting started"}),"\n",(0,s.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,s.jsx)(n.p,{children:"These are pretty much the only things you need to have installed on your machine to get started with contributing to this project:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["the ",(0,s.jsx)(n.a,{href:"https://www.rust-lang.org/tools/install",children:"Rust"})," toolchain installed on your machine"]}),"\n",(0,s.jsxs)(n.li,{children:["any working version of ",(0,s.jsx)(n.a,{href:"https://git-scm.com/downloads",children:"Git"})]}),"\n",(0,s.jsxs)(n.li,{children:["the ",(0,s.jsx)(n.a,{href:"https://github.com/casey/just",children:"just"})," command runner"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"forking-the-repository-and-setting-up-the-project",children:"Forking the repository and setting up the project"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["Click on the ",(0,s.jsx)(n.code,{children:"Fork"})," button at the top right corner of the repository page to create a copy of the repository to your GitHub account."]}),"\n",(0,s.jsxs)(n.li,{children:["Clone the forked repository to your local machine by running the following command in your terminal:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"git clone https://github.com//television.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Navigate to the project directory and set up the upstream remote by running the following commands:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"cd television\ngit remote add upstream https://github.com/alexpasmantier/television.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Install the project dependencies by running the following command:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just setup\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Create a new branch for your feature or bug fix:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"git checkout -b \n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Make your changes and test them locally. Predefined commands are available to make your life simpler, using them spares some time and effort:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just --list\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Once you're all set, commit them to your branch:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:'git add .\ngit commit -m "Your commit message"\n'})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Push your changes to your forked repository:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"git push origin \n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["If not done automatically, create a pull request by navigating to the original repository and clicking on the ",(0,s.jsx)(n.code,{children:"New pull request"})," button."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"developing-locally",children:"Developing locally"}),"\n",(0,s.jsx)(n.p,{children:"Before anything else (if not done already):"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just setup\n"})}),"\n",(0,s.jsx)(n.p,{children:"To run the application in debug mode while developing, with the ability to see logs and debug information:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just run\n"})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Accessing the Logs:"})}),"\n",(0,s.jsxs)(n.p,{children:["The logs are written to a file called ",(0,s.jsx)(n.code,{children:"television.log"})," in a directory that depends on your operating system / configuration:"]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Platform"}),(0,s.jsx)(n.th,{children:"Location"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Linux"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"$XDG_DATA_HOME/television/television.log"})," or ",(0,s.jsx)(n.code,{children:"$HOME/.local/share/television/television.log"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"macOS"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"$XDG_DATA_HOME/television/television.log"})," or ",(0,s.jsx)(n.code,{children:"$HOME/Library/Application\\ Support/television/television.log"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Windows"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{FOLDERID_LocalAppData}\\television\\television.log"})})]})]})]}),"\n",(0,s.jsx)(n.p,{children:"To check for linting and formatting issues (and fix them automatically), run:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just fix\n"})}),"\n",(0,s.jsx)(n.p,{children:"To get a sense of the real thing and test how your patch would behave in production, run:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just b release\n\n# or `just br`\n# or `just build release`\n"})}),"\n",(0,s.jsx)(n.p,{children:"Running the tests can be done with:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-shell",children:"just test\n"})}),"\n",(0,s.jsx)(n.h3,{id:"contributing-a-new-channel",children:"Contributing a new channel"}),"\n",(0,s.jsx)(n.p,{children:"Contributing a new channel is pretty straightforward."}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["create a new branch, add and commit your new channel's TOML file under ",(0,s.jsx)(n.code,{children:"cable/unix"})," (or ",(0,s.jsx)(n.code,{children:"cable/windows"})," depending on your usecase)"]}),"\n",(0,s.jsxs)(n.li,{children:["[optional] add a screenshot of the channel in ",(0,s.jsx)(n.code,{children:"assets/channels//"})," (e.g. ",(0,s.jsx)(n.code,{children:"assets/channels/unix/my_channel.png"}),")."]}),"\n",(0,s.jsx)(n.li,{children:"push your commit and create a PR"}),"\n",(0,s.jsx)(n.li,{children:"the ci will automatically generate the documentation for your channel and pick up the screenshot if available."}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"hot-topics",children:"Hot Topics"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"shell integration (autocomplete, keybindings)"}),"\n",(0,s.jsx)(n.li,{children:"packaging for various linux package managers (dnf, ...)"}),"\n",(0,s.jsx)(n.li,{children:"sorting options"}),"\n",(0,s.jsx)(n.li,{children:"ansi parsing"}),"\n",(0,s.jsx)(n.li,{children:"contributing new channels"}),"\n",(0,s.jsx)(n.li,{children:"improving code documentation"}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},5404:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>l});var i=t(6672);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.cdadbf17.js b/assets/js/runtime~main.3d485780.js similarity index 56% rename from assets/js/runtime~main.cdadbf17.js rename to assets/js/runtime~main.3d485780.js index b105866..bf2c78d 100644 --- a/assets/js/runtime~main.cdadbf17.js +++ b/assets/js/runtime~main.3d485780.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,r,f,d={},o={};function c(e){var a=o[e];if(void 0!==a)return a.exports;var t=o[e]={exports:{}};return d[e].call(t.exports,t,t.exports,c),t.exports}c.m=d,e=[],c.O=(a,t,r,f)=>{if(!t){var d=1/0;for(i=0;i=f)&&Object.keys(c.O).every((e=>c.O[e](t[b])))?t.splice(b--,1):(o=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[t,r,f]},c.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return c.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);c.r(f);var d={};a=a||[null,t({}),t([]),t(t)];for(var o=2&r&&e;"object"==typeof o&&!~a.indexOf(o);o=t(o))Object.getOwnPropertyNames(o).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,c.d(f,d),f},c.d=(e,a)=>{for(var t in a)c.o(a,t)&&!c.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((a,t)=>(c.f[t](e,a),a)),[])),c.u=e=>"assets/js/"+({20:"857f147c",536:"1648f67c",1235:"a7456010",1395:"2c30b35b",1610:"550bd6cf",1885:"7d83a5c3",2811:"b7be5ce9",3541:"96244980",4134:"393be207",4363:"3fd760d6",4583:"1df93b7f",4816:"b6c63517",4936:"7d3e8208",5507:"250fc3d7",5540:"a7b96eba",5742:"aba21aa0",5867:"43d79a02",5874:"6808264c",6061:"1f391b9e",6529:"dee5cafc",7098:"a7bd4aaa",7592:"e0ef48a2",8218:"1516f4b2",8401:"17896441",9048:"a94703ab",9090:"2bf9f277",9647:"5e95c892",9907:"e29aca6e"}[e]||e)+"."+{20:"4df4aa66",536:"52c293da",1235:"eb06d9db",1314:"07cf44c0",1370:"4772152a",1395:"ee049977",1480:"f403a739",1610:"d57b7618",1629:"c284e521",1874:"2a5dff10",1876:"0b5f0e50",1885:"f3a67656",1888:"2f318298",2013:"f5076cc2",2128:"12a92a60",2704:"71ca9602",2771:"49879a23",2811:"741d9797",3151:"62c54ee9",3523:"1955b085",3541:"a29984dd",3916:"f10368a6",4041:"9f98bea9",4134:"ffe3b8fa",4326:"bac7bdc2",4363:"d38ad1db",4583:"986d2027",4816:"330968f9",4874:"8919f2d0",4936:"3afbe6a2",5223:"f49cf1b4",5507:"a09b12dc",5540:"e1275cf6",5598:"f49a8466",5742:"4b02c646",5867:"5c18b3f2",5874:"c1eb28fa",5957:"af6947a2",6061:"6f1a187e",6205:"4a587adb",6231:"49be2dff",6236:"52501d4a",6446:"4121c8fb",6529:"57f23235",6595:"082d7f9c",6852:"f9cd4585",6884:"cd1dc064",7076:"1cffbb61",7098:"d924c49f",7592:"1ddc75d7",7633:"2ca4c018",7687:"810ed0e7",8028:"793c0503",8087:"453e7d82",8090:"3462f15a",8218:"bbc39d45",8401:"e626173f",8565:"1f3337c9",8890:"3d136a4c",8941:"5ce23ff2",8989:"3aaf54b9",9048:"821c35a4",9090:"dd4fb3cf",9402:"1d4cb10a",9439:"fd791b9e",9440:"3de73410",9647:"0bf46dad",9824:"ee556fef",9907:"60bb70a8",9952:"dd1f41fa"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},f="television-website:",c.l=(e,a,t,d)=>{if(r[e])r[e].push(a);else{var o,b;if(void 0!==t)for(var n=document.getElementsByTagName("script"),i=0;i{o.onerror=o.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],o.parentNode&&o.parentNode.removeChild(o),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:o}),12e4);o.onerror=u.bind(null,o.onerror),o.onload=u.bind(null,o.onload),b&&document.head.appendChild(o)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/television/",c.gca=function(e){return e={17896441:"8401",96244980:"3541","857f147c":"20","1648f67c":"536",a7456010:"1235","2c30b35b":"1395","550bd6cf":"1610","7d83a5c3":"1885",b7be5ce9:"2811","393be207":"4134","3fd760d6":"4363","1df93b7f":"4583",b6c63517:"4816","7d3e8208":"4936","250fc3d7":"5507",a7b96eba:"5540",aba21aa0:"5742","43d79a02":"5867","6808264c":"5874","1f391b9e":"6061",dee5cafc:"6529",a7bd4aaa:"7098",e0ef48a2:"7592","1516f4b2":"8218",a94703ab:"9048","2bf9f277":"9090","5e95c892":"9647",e29aca6e:"9907"}[e]||e,c.p+c.u(e)},(()=>{var e={5354:0,1869:0};c.f.j=(a,t)=>{var r=c.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>r=e[a]=[t,f]));t.push(r[2]=f);var d=c.p+c.u(a),o=new Error;c.l(d,(t=>{if(c.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var f=t&&("load"===t.type?"missing":t.type),d=t&&t.target&&t.target.src;o.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",o.name="ChunkLoadError",o.type=f,o.request=d,r[1](o)}}),"chunk-"+a,a)}},c.O.j=a=>0===e[a];var a=(a,t)=>{var r,f,d=t[0],o=t[1],b=t[2],n=0;if(d.some((a=>0!==e[a]))){for(r in o)c.o(o,r)&&(c.m[r]=o[r]);if(b)var i=b(c)}for(a&&a(t);n{"use strict";var e,t,a,r,f,d={},o={};function c(e){var t=o[e];if(void 0!==t)return t.exports;var a=o[e]={exports:{}};return d[e].call(a.exports,a,a.exports,c),a.exports}c.m=d,e=[],c.O=(t,a,r,f)=>{if(!a){var d=1/0;for(i=0;i=f)&&Object.keys(c.O).every((e=>c.O[e](a[b])))?a.splice(b--,1):(o=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[a,r,f]},c.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return c.d(t,{a:t}),t},a=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);c.r(f);var d={};t=t||[null,a({}),a([]),a(a)];for(var o=2&r&&e;"object"==typeof o&&!~t.indexOf(o);o=a(o))Object.getOwnPropertyNames(o).forEach((t=>d[t]=()=>e[t]));return d.default=()=>e,c.d(f,d),f},c.d=(e,t)=>{for(var a in t)c.o(t,a)&&!c.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:t[a]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((t,a)=>(c.f[a](e,t),t)),[])),c.u=e=>"assets/js/"+({20:"857f147c",536:"1648f67c",1235:"a7456010",1395:"2c30b35b",1610:"550bd6cf",1885:"7d83a5c3",2811:"b7be5ce9",3541:"96244980",4134:"393be207",4363:"3fd760d6",4583:"1df93b7f",4816:"b6c63517",4936:"7d3e8208",5507:"250fc3d7",5540:"a7b96eba",5742:"aba21aa0",5867:"43d79a02",5874:"6808264c",6061:"1f391b9e",6529:"dee5cafc",7098:"a7bd4aaa",7592:"e0ef48a2",8218:"1516f4b2",8401:"17896441",9048:"a94703ab",9090:"2bf9f277",9647:"5e95c892",9907:"e29aca6e"}[e]||e)+"."+{20:"4df4aa66",536:"52c293da",1235:"eb06d9db",1314:"07cf44c0",1370:"4772152a",1395:"ee049977",1480:"f403a739",1610:"d57b7618",1629:"c284e521",1874:"2a5dff10",1876:"0b5f0e50",1885:"f3a67656",1888:"2f318298",2013:"f5076cc2",2128:"12a92a60",2704:"71ca9602",2771:"49879a23",2811:"741d9797",3151:"62c54ee9",3523:"1955b085",3541:"a29984dd",3916:"f10368a6",4041:"9f98bea9",4134:"ffe3b8fa",4326:"bac7bdc2",4363:"d38ad1db",4583:"986d2027",4816:"330968f9",4874:"8919f2d0",4936:"3afbe6a2",5223:"f49cf1b4",5507:"a09b12dc",5540:"e1275cf6",5598:"f49a8466",5742:"4b02c646",5867:"5c18b3f2",5874:"c1eb28fa",5957:"af6947a2",6061:"6f1a187e",6205:"4a587adb",6231:"49be2dff",6236:"52501d4a",6446:"4121c8fb",6529:"57f23235",6595:"082d7f9c",6852:"f9cd4585",6884:"cd1dc064",7076:"1cffbb61",7098:"d924c49f",7592:"1b5927d1",7633:"2ca4c018",7687:"810ed0e7",8028:"793c0503",8087:"453e7d82",8090:"3462f15a",8218:"bbc39d45",8401:"e626173f",8565:"1f3337c9",8890:"3d136a4c",8941:"5ce23ff2",8989:"3aaf54b9",9048:"821c35a4",9090:"dd4fb3cf",9402:"1d4cb10a",9439:"fd791b9e",9440:"3de73410",9647:"0bf46dad",9824:"ee556fef",9907:"60bb70a8",9952:"dd1f41fa"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r={},f="television-website:",c.l=(e,t,a,d)=>{if(r[e])r[e].push(t);else{var o,b;if(void 0!==a)for(var n=document.getElementsByTagName("script"),i=0;i{o.onerror=o.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],o.parentNode&&o.parentNode.removeChild(o),f&&f.forEach((e=>e(a))),t)return t(a)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:o}),12e4);o.onerror=u.bind(null,o.onerror),o.onload=u.bind(null,o.onload),b&&document.head.appendChild(o)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/television/",c.gca=function(e){return e={17896441:"8401",96244980:"3541","857f147c":"20","1648f67c":"536",a7456010:"1235","2c30b35b":"1395","550bd6cf":"1610","7d83a5c3":"1885",b7be5ce9:"2811","393be207":"4134","3fd760d6":"4363","1df93b7f":"4583",b6c63517:"4816","7d3e8208":"4936","250fc3d7":"5507",a7b96eba:"5540",aba21aa0:"5742","43d79a02":"5867","6808264c":"5874","1f391b9e":"6061",dee5cafc:"6529",a7bd4aaa:"7098",e0ef48a2:"7592","1516f4b2":"8218",a94703ab:"9048","2bf9f277":"9090","5e95c892":"9647",e29aca6e:"9907"}[e]||e,c.p+c.u(e)},(()=>{var e={5354:0,1869:0};c.f.j=(t,a)=>{var r=c.o(e,t)?e[t]:void 0;if(0!==r)if(r)a.push(r[2]);else if(/^(1869|5354)$/.test(t))e[t]=0;else{var f=new Promise(((a,f)=>r=e[t]=[a,f]));a.push(r[2]=f);var d=c.p+c.u(t),o=new Error;c.l(d,(a=>{if(c.o(e,t)&&(0!==(r=e[t])&&(e[t]=void 0),r)){var f=a&&("load"===a.type?"missing":a.type),d=a&&a.target&&a.target.src;o.message="Loading chunk "+t+" failed.\n("+f+": "+d+")",o.name="ChunkLoadError",o.type=f,o.request=d,r[1](o)}}),"chunk-"+t,t)}},c.O.j=t=>0===e[t];var t=(t,a)=>{var r,f,d=a[0],o=a[1],b=a[2],n=0;if(d.some((t=>0!==e[t]))){for(r in o)c.o(o,r)&&(c.m[r]=o[r]);if(b)var i=b(c)}for(t&&t(a);n Architecture Documentation | Television - + diff --git a/docs/Developers/contributing/index.html b/docs/Developers/contributing/index.html index 6239808..e9f48c6 100644 --- a/docs/Developers/contributing/index.html +++ b/docs/Developers/contributing/index.html @@ -4,7 +4,7 @@ Contributing | Television - + @@ -68,7 +68,9 @@

Contributing a new channel is pretty straightforward.

  1. create a new branch, add and commit your new channel's TOML file under cable/unix (or cable/windows depending on your usecase)
    2. +
  2. [optional] add a screenshot of the channel in assets/channels/<os>/ (e.g. assets/channels/unix/my_channel.png).
  3. push your commit and create a PR
    4. +
  4. the ci will automatically generate the documentation for your channel and pick up the screenshot if available.

Hot Topics​

    diff --git a/docs/Developers/patch-notes/index.html b/docs/Developers/patch-notes/index.html index 36f779a..3a63413 100644 --- a/docs/Developers/patch-notes/index.html +++ b/docs/Developers/patch-notes/index.html @@ -4,7 +4,7 @@ Release notes for television 0.12.0 | Television - + diff --git a/docs/Developers/shell-integration-local/index.html b/docs/Developers/shell-integration-local/index.html index 5cb1d11..61fb21f 100644 --- a/docs/Developers/shell-integration-local/index.html +++ b/docs/Developers/shell-integration-local/index.html @@ -4,7 +4,7 @@ Shell Integration: Developing locally | Television - + diff --git a/docs/Developers/ui-features/index.html b/docs/Developers/ui-features/index.html index 8d97894..8ec7b1d 100644 --- a/docs/Developers/ui-features/index.html +++ b/docs/Developers/ui-features/index.html @@ -4,7 +4,7 @@ UI Features documentation | Television - + diff --git a/docs/Users/channels/index.html b/docs/Users/channels/index.html index 84d9575..1812e45 100644 --- a/docs/Users/channels/index.html +++ b/docs/Users/channels/index.html @@ -4,7 +4,7 @@ Channels | Television - + diff --git a/docs/Users/cli/index.html b/docs/Users/cli/index.html index c5a1503..dca38f8 100644 --- a/docs/Users/cli/index.html +++ b/docs/Users/cli/index.html @@ -4,7 +4,7 @@ CLI Reference | Television - + diff --git a/docs/Users/community-channels-unix/index.html b/docs/Users/community-channels-unix/index.html index 32a6ad7..93866fb 100644 --- a/docs/Users/community-channels-unix/index.html +++ b/docs/Users/community-channels-unix/index.html @@ -4,7 +4,7 @@ 🍿 Community Channels (unix) | Television - + diff --git a/docs/Users/community-channels-windows/index.html b/docs/Users/community-channels-windows/index.html index 928dc6b..713783d 100644 --- a/docs/Users/community-channels-windows/index.html +++ b/docs/Users/community-channels-windows/index.html @@ -4,7 +4,7 @@ 🍿 Community Channels (windows) | Television - + diff --git a/docs/Users/configuration/index.html b/docs/Users/configuration/index.html index f1b6ddc..b480a9c 100644 --- a/docs/Users/configuration/index.html +++ b/docs/Users/configuration/index.html @@ -4,7 +4,7 @@ Configuration | Television - + diff --git a/docs/Users/installation/index.html b/docs/Users/installation/index.html index b55c53e..1cbb65e 100644 --- a/docs/Users/installation/index.html +++ b/docs/Users/installation/index.html @@ -4,7 +4,7 @@ Installation | Television - + diff --git a/docs/Users/keybindings/index.html b/docs/Users/keybindings/index.html index f8b8d96..8cc1397 100644 --- a/docs/Users/keybindings/index.html +++ b/docs/Users/keybindings/index.html @@ -4,7 +4,7 @@ Keybindings | Television - + diff --git a/docs/Users/quickstart/index.html b/docs/Users/quickstart/index.html index c990808..61adea1 100644 --- a/docs/Users/quickstart/index.html +++ b/docs/Users/quickstart/index.html @@ -4,7 +4,7 @@ Quickstart | Television - + diff --git a/docs/Users/search-patterns/index.html b/docs/Users/search-patterns/index.html index c2851d7..022d0dc 100644 --- a/docs/Users/search-patterns/index.html +++ b/docs/Users/search-patterns/index.html @@ -4,7 +4,7 @@ Search Patterns | Television - + diff --git a/docs/Users/shell-integration/index.html b/docs/Users/shell-integration/index.html index 486af54..48670f6 100644 --- a/docs/Users/shell-integration/index.html +++ b/docs/Users/shell-integration/index.html @@ -4,7 +4,7 @@ Shell Integration | Television - + diff --git a/docs/Users/showcase/index.html b/docs/Users/showcase/index.html index 574da6e..f7474de 100644 --- a/docs/Users/showcase/index.html +++ b/docs/Users/showcase/index.html @@ -4,7 +4,7 @@ Showcase | Television - + diff --git a/docs/Users/terminal_emulators/index.html b/docs/Users/terminal_emulators/index.html index a7e6d4b..ae9e96d 100644 --- a/docs/Users/terminal_emulators/index.html +++ b/docs/Users/terminal_emulators/index.html @@ -4,7 +4,7 @@ Terminal Emulators | Television - + diff --git a/docs/Users/themes/index.html b/docs/Users/themes/index.html index 67c503e..3fbd4cd 100644 --- a/docs/Users/themes/index.html +++ b/docs/Users/themes/index.html @@ -4,7 +4,7 @@ Themes | Television - + diff --git a/index.html b/index.html index 668a62f..0a1332d 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ Television - + diff --git a/markdown-page/index.html b/markdown-page/index.html index b287b64..ded64c8 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -4,7 +4,7 @@ Markdown page example | Television - +