mirror of
https://github.com/movie-web/providers.git
synced 2025-09-13 11:33:25 +00:00
Doc directory structure
This commit is contained in:
5
.docs/content/1.Get Started/0.introduction.md
Normal file
5
.docs/content/1.Get Started/0.introduction.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# Introduction
|
||||||
|
|
||||||
|
- What is this project
|
||||||
|
- How does it work?
|
||||||
|
- What environments can it be ran in?
|
@@ -1,4 +1,8 @@
|
|||||||
# Usage
|
# Quick start
|
||||||
|
|
||||||
|
- Prerequisites
|
||||||
|
- Install
|
||||||
|
- Scrape first item
|
||||||
|
|
||||||
Let's get started with `@movie-web/providers`. First lets install the package.
|
Let's get started with `@movie-web/providers`. First lets install the package.
|
||||||
|
|
2
.docs/content/1.Get Started/_dir.yml
Normal file
2
.docs/content/1.Get Started/_dir.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
icon: ph:book-open-fill
|
||||||
|
navigation.redirect: /get-started/introduction
|
@@ -1,2 +0,0 @@
|
|||||||
icon: ph:book-open-fill
|
|
||||||
navigation.redirect: /guide/usage
|
|
6
.docs/content/2.Essentials/0.usage-on-x.md
Normal file
6
.docs/content/2.Essentials/0.usage-on-x.md
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
# How to use on X
|
||||||
|
|
||||||
|
- General usage
|
||||||
|
- How to run on server?
|
||||||
|
- How to run on client?
|
||||||
|
- How to run on native app?
|
5
.docs/content/2.Essentials/3.customize-providers.md
Normal file
5
.docs/content/2.Essentials/3.customize-providers.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# Customize providers
|
||||||
|
|
||||||
|
- use makeProviders()
|
||||||
|
- use buildProviders()
|
||||||
|
- only use some providers
|
4
.docs/content/2.Essentials/4.using-streams.md
Normal file
4
.docs/content/2.Essentials/4.using-streams.md
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
# Using streams
|
||||||
|
|
||||||
|
- How to use the outputs
|
||||||
|
- file based streams VS hls
|
2
.docs/content/2.Essentials/_dir.yml
Normal file
2
.docs/content/2.Essentials/_dir.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
icon: ph:book-open-fill
|
||||||
|
navigation.redirect: /essentials/usage
|
4
.docs/content/3.In-depth/0.sources-and-embeds.md
Normal file
4
.docs/content/3.In-depth/0.sources-and-embeds.md
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
# Sources vs embeds
|
||||||
|
|
||||||
|
- How do sources and embeds differ
|
||||||
|
- How do sources and embeds interact
|
5
.docs/content/3.In-depth/1.new-providers.md
Normal file
5
.docs/content/3.In-depth/1.new-providers.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# New providers
|
||||||
|
|
||||||
|
- How to make new sources or embeds
|
||||||
|
- Ranking
|
||||||
|
- Link to flags
|
4
.docs/content/3.In-depth/2.flags.md
Normal file
4
.docs/content/3.In-depth/2.flags.md
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
# Flags
|
||||||
|
|
||||||
|
- what are flags?
|
||||||
|
- list of all flags and their meaning
|
2
.docs/content/3.In-depth/_dir.yml
Normal file
2
.docs/content/3.In-depth/_dir.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
icon: ph:book-open-fill
|
||||||
|
navigation.redirect: /in-depth/sources-and-embeds
|
7
.docs/content/4.Extra topics/0.development.md
Normal file
7
.docs/content/4.Extra topics/0.development.md
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# Development / contributing
|
||||||
|
|
||||||
|
- Development setup
|
||||||
|
- How to make new sources/embeds (link to the page)
|
||||||
|
- How to use the fetchers, when to use proxiedFetcher
|
||||||
|
- How to use the context
|
||||||
|
- Testing of contributions
|
2
.docs/content/4.Extra topics/_dir.yml
Normal file
2
.docs/content/4.Extra topics/_dir.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
icon: ph:book-open-fill
|
||||||
|
navigation.redirect: /extra-topics/development
|
9018
.docs/pnpm-lock.yaml
generated
Normal file
9018
.docs/pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user