mirror of
https://github.com/TheBinaryNinja/tvapp2.git
synced 2026-06-04 10:15:41 -04:00
docs: integrate mkdocs into repository
This commit is contained in:
0
docs/docs/about/backers.md
Normal file
0
docs/docs/about/backers.md
Normal file
26
docs/docs/about/changelog.md
Normal file
26
docs/docs/about/changelog.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Changelog
|
||||
tags:
|
||||
- changelog
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
<p align="center" markdown="1">
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
</p>
|
||||
|
||||
### <!-- md:version stable- --> 1.0.0 <small>Feb 24, 2025</small> { id="1.0.0" }
|
||||
|
||||
|
||||
|
||||
<br />
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
109
docs/docs/about/conventions.md
Normal file
109
docs/docs/about/conventions.md
Normal file
@@ -0,0 +1,109 @@
|
||||
# Conventions
|
||||
This documentation use some symbols for illustration purposes. Before you read
|
||||
on, please make sure you've made yourself familiar with the following list of
|
||||
conventions:
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:version --> Release Type { data-toc-label="Version" }
|
||||
|
||||
The tag symbol in conjunction with a version number denotes when a specific feature or behavior was added. Make sure you're at least on this version if you want to use it.
|
||||
|
||||
: <!-- md:version stable- --> stable
|
||||
: <!-- md:version beta- --> beta
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:control --> Controls { #default data-toc-label="Control" }
|
||||
|
||||
These icons define what type of control a specified setting uses.
|
||||
|
||||
: <!-- md:control toggle --> toggle
|
||||
: <!-- md:control textbox --> textbox
|
||||
: <!-- md:control dropdown --> dropdown
|
||||
: <!-- md:control button --> button
|
||||
: <!-- md:control slider --> slider
|
||||
: <!-- md:control color --> color wheel
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:default --> – Default Value { #default data-toc-label="Default value" }
|
||||
|
||||
This defines what the default value for a setting is.
|
||||
|
||||
: <!-- md:default --> Specified setting has a default value
|
||||
: <!-- md:default none --> Specified setting has no default value and is empty
|
||||
: <!-- md:default computed --> Specified setting is automatically computed by the app
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:command --> – Command { #command data-toc-label="Command" }
|
||||
|
||||
This defines a command
|
||||
|
||||
: <!-- md:command --> Specified setting has a default value
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:flag experimental --> – Experimental { data-toc-label="Experimental" }
|
||||
|
||||
Anything listed with this icon are features or functionality that are still in development and may change in future versions.
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:flag required --> – Required value { #required data-toc-label="Required value" }
|
||||
|
||||
Items listed with this symbol indicate that they are required to be set.
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:flag customization --> – Customization { #customization data-toc-label="Customization" }
|
||||
|
||||
This symbol denotes that the item described is a customization which affects the overall look of the app.
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:3rdparty --> – 3rd Party { data-toc-label="3rd Party" }
|
||||
|
||||
This symbol denotes that the item described is classified as something that changes the overall functionality of the plugin.
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:flag metadata --> – Metadata property { #metadata data-toc-label="Metadata property" }
|
||||
|
||||
This symbol denotes that the item described is a metadata property, which can
|
||||
be used in Markdown documents as part of the front matter definition.
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:flag setting --> – Configurable Setting { #setting data-toc-label="Configurable Setting" }
|
||||
|
||||
This symbol denotes that an item is configurable by the user
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:flag multiple --> – Multiple instances { #multiple-instances data-toc-label="Multiple instances" }
|
||||
|
||||
This symbol denotes that the plugin supports multiple instances, i.e, that it
|
||||
can be used multiple times in the `plugins` setting in `mkdocs.yml`.
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:feature --> – Optional feature { #feature data-toc-label="Optional feature" }
|
||||
|
||||
Most of the features are hidden behind feature flags, which means they must
|
||||
be explicitly enabled via `mkdocs.yml`. This allows for the existence of
|
||||
potentially orthogonal features.
|
||||
|
||||
<br />
|
||||
|
||||
### <!-- md:backers --> – Backers only { data-toc-label="Backers only" }
|
||||
|
||||
The pumping heart symbol denotes that a specific feature or behavior is only
|
||||
available to backers. Normal users will not have access to this particular item.
|
||||
|
||||
<br />
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
29
docs/docs/about/license.md
Normal file
29
docs/docs/about/license.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# License
|
||||
|
||||
**MIT License**
|
||||
|
||||
Copyright (c) 2025 Aetherinox
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to
|
||||
deal in the Software without restriction, including without limitation the
|
||||
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
||||
sell copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||||
IN THE SOFTWARE.
|
||||
|
||||
<br />
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
11
docs/docs/about/tags.md
Normal file
11
docs/docs/about/tags.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Tags
|
||||
|
||||
Following is a list of relevant tags:
|
||||
|
||||
<!-- material/tags -->
|
||||
|
||||
<br />
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
13
docs/docs/about_tvapp2.md
Normal file
13
docs/docs/about_tvapp2.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: About TVApp2
|
||||
tags:
|
||||
- info
|
||||
---
|
||||
|
||||
# About TVApp2
|
||||
|
||||
<br />
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
BIN
docs/docs/assets/favicon.png
Normal file
BIN
docs/docs/assets/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8.2 KiB |
BIN
docs/docs/assets/images/illustration.png
Normal file
BIN
docs/docs/assets/images/illustration.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 193 KiB |
16
docs/docs/blog/.authors.yml
Normal file
16
docs/docs/blog/.authors.yml
Normal file
@@ -0,0 +1,16 @@
|
||||
authors:
|
||||
Aetherinox:
|
||||
name: Aetherinox
|
||||
description: Developer
|
||||
avatar: https://avatars.githubusercontent.com/u/118329232
|
||||
url: https://github.com/Aetherinox
|
||||
iflip721:
|
||||
name: iflip721
|
||||
description: Developer
|
||||
avatar: https://avatars.githubusercontent.com/u/28721588
|
||||
url: https://github.com/iflip721
|
||||
Optx:
|
||||
name: Optx
|
||||
description: Developer
|
||||
avatar: https://avatars.githubusercontent.com/u/32874812
|
||||
url: https://github.com/Nvmdfth
|
||||
3
docs/docs/blog/.meta.yml
Normal file
3
docs/docs/blog/.meta.yml
Normal file
@@ -0,0 +1,3 @@
|
||||
comments: true
|
||||
hide:
|
||||
- feedback
|
||||
1
docs/docs/blog/index.md
Normal file
1
docs/docs/blog/index.md
Normal file
@@ -0,0 +1 @@
|
||||
# Blog
|
||||
34
docs/docs/home.md
Normal file
34
docs/docs/home.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Home
|
||||
tags:
|
||||
- home
|
||||
---
|
||||
|
||||
<p align="center"><img src="https://techcrunch.com/wp-content/uploads/2017/10/roku-live-tv-screen-1600x900.png" width="860"></p>
|
||||
<h1 align="center"><b>TVApp2</b></h1>
|
||||
|
||||
<p align="center" markdown="1">
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
</p>
|
||||
|
||||
This documentation is related to the github repository for <a href="https://github.com/TheBinaryNinja/tvapp2">TVApp2</a>; a NodeJS powered application which allows you to fetch M3U playlists and EPG guide data from various popular online IPTV services such as TheTvApp, TVPass, and MoveOnJoy. These services provide high-quality and premium channels available as Live TV.
|
||||
|
||||
<br />
|
||||
|
||||
This documentation covers the following:
|
||||
|
||||
- How to install and configure TVApp2
|
||||
- Managing your TVApp2 docker image
|
||||
- Building your own docker image
|
||||
- Traefik and Authentik Integration
|
||||
|
||||
<br />
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
9
docs/docs/index.md
Normal file
9
docs/docs/index.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
template: home.html
|
||||
title: TVApp2
|
||||
social:
|
||||
cards_layout_options:
|
||||
title: TVApp2
|
||||
---
|
||||
|
||||
Welcome to the TVApp2 documentation
|
||||
0
docs/docs/plugins/index.md
Normal file
0
docs/docs/plugins/index.md
Normal file
1278
docs/docs/stylesheets/extra.css
Normal file
1278
docs/docs/stylesheets/extra.css
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user