Doc directory structure

This commit is contained in:
mrjvs
2023-12-26 23:35:58 +01:00
parent ddf612c6cc
commit 7143b06c55
27 changed files with 9071 additions and 3 deletions

View File

@@ -0,0 +1,5 @@
# Introduction
- What is this project
- How does it work?
- What environments can it be ran in?

View File

@@ -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.

View File

@@ -0,0 +1,2 @@
icon: ph:book-open-fill
navigation.redirect: /get-started/introduction

View File

@@ -1,2 +0,0 @@
icon: ph:book-open-fill
navigation.redirect: /guide/usage

View 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?

View File

@@ -0,0 +1,5 @@
# Customize providers
- use makeProviders()
- use buildProviders()
- only use some providers

View File

@@ -0,0 +1,4 @@
# Using streams
- How to use the outputs
- file based streams VS hls

View File

@@ -0,0 +1,2 @@
icon: ph:book-open-fill
navigation.redirect: /essentials/usage

View File

@@ -0,0 +1,4 @@
# Sources vs embeds
- How do sources and embeds differ
- How do sources and embeds interact

View File

@@ -0,0 +1,5 @@
# New providers
- How to make new sources or embeds
- Ranking
- Link to flags

View File

@@ -0,0 +1,4 @@
# Flags
- what are flags?
- list of all flags and their meaning

View File

@@ -0,0 +1,2 @@
icon: ph:book-open-fill
navigation.redirect: /in-depth/sources-and-embeds

View 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

View File

@@ -0,0 +1,2 @@
icon: ph:book-open-fill
navigation.redirect: /extra-topics/development

9018
.docs/pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff