This commit is contained in:
Mohit
2024-04-17 17:17:38 +02:00
committed by GitHub
69 changed files with 2947 additions and 7912 deletions

7
.docs/.editorconfig Normal file
View File

@@ -0,0 +1,7 @@
root = true
[*]
end_of_line = lf
insert_final_newline = true
indent_size = 2
indent_style = space

View File

@@ -1,4 +1,6 @@
dist dist
node_modules node_modules
.output .output
.nuxt public
# Ignore index due to prettier removing setext headers
*.index.md

View File

@@ -1,8 +1,6 @@
module.exports = { module.exports = {
root: true, extends: ['next', 'plugin:prettier/recommended'],
extends: '@nuxt/eslint-config',
rules: { rules: {
'vue/max-attributes-per-line': 'off', '@next/next/no-img-element': 'off',
'vue/multi-word-component-names': 'off' },
} };
}

1
.docs/.gitattributes vendored Normal file
View File

@@ -0,0 +1 @@
* text=auto eol=lf

1
.docs/.github/CODEOWNERS vendored Normal file
View File

@@ -0,0 +1 @@
* @movie-web/project-leads

1
.docs/.github/CODE_OF_CONDUCT.md vendored Normal file
View File

@@ -0,0 +1 @@
Please visit the [main document at primary repository](https://github.com/movie-web/movie-web/blob/dev/.github/CODE_OF_CONDUCT.md).

1
.docs/.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1 @@
Please visit the [main document at primary repository](https://github.com/movie-web/movie-web/blob/dev/.github/CONTRIBUTING.md).

View File

@@ -0,0 +1,49 @@
name: "docs-deploy"
on:
push:
branches:
- master
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: pnpm
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Build
run: pnpm build
- name: Upload
uses: actions/upload-pages-artifact@v3
with:
path: ./out
deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

32
.docs/.github/workflows/linting.yml vendored Normal file
View File

@@ -0,0 +1,32 @@
name: Linting and Testing
on:
push:
branches:
- master
pull_request:
jobs:
linting:
name: Run Linters
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- uses: pnpm/action-setup@v3
with:
version: 8
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'pnpm'
- name: Install pnpm packages
run: pnpm install
- name: Run ESLint
run: pnpm run lint

5
.docs/.gitignore vendored
View File

@@ -2,12 +2,11 @@ node_modules
*.iml *.iml
.idea .idea
*.log* *.log*
.nuxt
.vscode .vscode
.DS_Store .DS_Store
coverage coverage
dist dist
sw.* sw.*
.env .env
.output out
.nuxt .next

3
.docs/.prettierignore Normal file
View File

@@ -0,0 +1,3 @@
# Ignore index due to prettier removing setext headers
*.index.md
.github/CODEOWNERS

4
.docs/.prettierrc Normal file
View File

@@ -0,0 +1,4 @@
{
"trailingComma": "all",
"singleQuote": true
}

21
.docs/LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 movie-web
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 NONINFRINGEMENT. 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.

View File

@@ -1,17 +0,0 @@
export default defineAppConfig({
docus: {
title: '@movie-web/providers',
description: 'For all your media scraping needs',
socials: {
github: 'movie-web/providers',
},
image: '',
aside: {
level: 0,
exclude: [],
},
header: {
logo: false,
},
},
});

View File

@@ -1,3 +0,0 @@
code > span {
white-space: pre;
}

BIN
.docs/bun.lockb Normal file

Binary file not shown.

View File

@@ -0,0 +1,18 @@
.logo {
border-radius: 5px;
margin-left: -0.5rem;
padding: 0.5rem;
transition: transform 100ms ease-in-out, background-color 100ms ease-in-out;
}
.logo > img {
height: 1.5rem;
}
.logo:hover {
background-color: rgba(var(--colors-bgLightest));
}
.logo:active {
transform: scale(1.05);
}

11
.docs/components/Logo.tsx Normal file
View File

@@ -0,0 +1,11 @@
import Link from 'next/link';
import classes from './Logo.module.css';
import logoUrl from '../public/icon-light.png';
export function Logo() {
return (
<Link href="/" className={classes.logo}>
<img src={logoUrl.src} alt="Logo of movie-web" />
</Link>
);
}

View File

@@ -1,51 +0,0 @@
---
title: "@movie-web/providers | For all your media scraping needs"
navigation: false
layout: page
---
::block-hero
---
cta:
- Get Started
- /get-started/introduction
secondary:
- Open on GitHub →
- https://github.com/movie-web/providers
snippet: npm i @movie-web/providers
---
#title
@movie-web/providers
#description
Easily scrape all sorts of media sites for content
::
::card-grid
#title
What's included
#root
:ellipsis
#default
::card{icon="vscode-icons:file-type-light-json"}
#title
Scrape popular streaming websites.
#description
Don't settle for just one media site for you content, use everything that's available.
::
::card{icon="codicon:source-control"}
#title
Multi-platform.
#description
Scrape from browser or server, whichever you prefer.
::
::card{icon="logos:typescript-icon-round"}
#title
Easy to use.
#description
Get started with scraping your favourite media sites with just 5 lines of code. Fully typed of course.
::
::

View File

@@ -1,5 +0,0 @@
# Examples
::alert{type="warning"}
There are no examples yet, stay tuned!
::

View File

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

View File

@@ -1,3 +0,0 @@
icon: ph:info-fill
navigation.redirect: /essentials/usage
navigation.title: "Get started"

View File

@@ -1,3 +0,0 @@
icon: ph:atom-fill
navigation.redirect: /in-depth/sources-and-embeds
navigation.title: "In-depth"

View File

@@ -1,3 +0,0 @@
icon: ph:aperture-fill
navigation.redirect: /extra-topics/development
navigation.title: "Extra topics"

5
.docs/next-env.d.ts vendored Normal file
View File

@@ -0,0 +1,5 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.

10
.docs/next.config.mjs Normal file
View File

@@ -0,0 +1,10 @@
import { guider } from '@neato/guider';
const withGuider = guider({
themeConfig: './theme.config.tsx',
});
export default withGuider({
output: 'export',
basePath: '/providers',
});

View File

@@ -1,21 +0,0 @@
export default defineNuxtConfig({
// https://github.com/nuxt-themes/docus
extends: '@nuxt-themes/docus',
css: [
'@/assets/css/main.css',
],
build: {
transpile: [
"chalk"
]
},
modules: [
// https://github.com/nuxt-modules/plausible
'@nuxtjs/plausible',
// https://github.com/nuxt/devtools
'@nuxt/devtools'
]
})

View File

@@ -1,22 +1,28 @@
{ {
"name": "providers-docs", "name": "providers-docs",
"version": "0.1.0", "version": "0.2.0",
"private": true, "private": true,
"scripts": { "scripts": {
"dev": "nuxi dev", "dev": "next dev",
"build": "nuxi build", "build": "next build",
"generate": "nuxi generate", "start": "next start",
"preview": "nuxi preview", "lint": "next lint",
"lint": "eslint .", "lint:fix": "next lint --fix"
"preinstall": "npx -y only-allow pnpm"
}, },
"devDependencies": { "devDependencies": {
"@nuxt-themes/docus": "^1.13.1", "@types/react": "18.2.73",
"@nuxt/devtools": "^1.0.1", "eslint": "^8.56.0",
"@nuxt/eslint-config": "^0.1.1", "eslint-config-next": "^14.1.4",
"@nuxtjs/plausible": "^0.2.1", "eslint-config-prettier": "^9.1.0",
"@types/node": "^20.4.0", "eslint-plugin-prettier": "^5.1.2",
"eslint": "^8.44.0", "prettier": "^3.1.1",
"nuxt": "^3.6.2" "typescript": "5.4.3"
},
"dependencies": {
"@neato/guider": "^0.1.5",
"next": "^14.1.4",
"next-seo": "^6.5.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
} }
} }

3
.docs/pages/404.tsx Normal file
View File

@@ -0,0 +1,3 @@
import { createNotFoundPage } from '@neato/guider/client';
export default createNotFoundPage();

4
.docs/pages/_app.tsx Normal file
View File

@@ -0,0 +1,4 @@
import '@neato/guider/style.css';
import { createGuiderApp } from '@neato/guider/client';
export default createGuiderApp();

View File

@@ -6,8 +6,10 @@ You can attach events if you need to know what is going on while it is processin
## Example ## Example
```ts ```ts
import { ScrapeMedia, targets } from '@movie-web/providers';
// media from TMDB // media from TMDB
const media = { const media : ScrapeMedia = {
type: 'movie', type: 'movie',
title: 'Hamilton', title: 'Hamilton',
releaseYear: 2020, releaseYear: 2020,

View File

@@ -5,10 +5,10 @@ Run a specific source scraper and get its emitted streams.
## Example ## Example
```ts ```ts
import { SourcererOutput, NotFoundError } from '@movie-web/providers'; import { ScrapeMedia , SourcererOutput, NotFoundError } from '@movie-web/providers';
// media from TMDB // media from TMDB
const media = { const media : ScrapeMedia = {
type: 'movie', type: 'movie',
title: 'Hamilton', title: 'Hamilton',
releaseYear: 2020, releaseYear: 2020,

View File

@@ -0,0 +1,3 @@
import { createRedirect } from '@neato/guider/client';
export default createRedirect({ to: '/api-reference/makeProviders' });

View File

@@ -0,0 +1,3 @@
import { createRedirect } from '@neato/guider/client';
export default createRedirect({ to: '/essentials/usage-on-x' });

View File

@@ -2,10 +2,10 @@
When creating provider controls, you will immediately be required to choose a target. When creating provider controls, you will immediately be required to choose a target.
::alert{type="warning"} <Warning>
A target is the device on which the stream will be played. A target is the device on which the stream will be played.
**Where the scraping is run has nothing to do with the target**, only where the stream is finally played in the end is significant in choosing a target. **Where the scraping is being run has nothing to do with the target**, only where the stream is finally played in the end is significant in choosing a target.
:: </Warning>
#### Possible targets #### Possible targets
- **`targets.BROWSER`** Stream will be played in a browser with CORS - **`targets.BROWSER`** Stream will be played in a browser with CORS

View File

@@ -24,7 +24,7 @@ const providers = makeProviders({
## Browser client-side ## Browser client-side
Using the provider package client-side requires a hosted version of simple-proxy. Using the provider package client-side requires a hosted version of simple-proxy.
Read more [about proxy fetchers](./2.fetchers.md#using-fetchers-on-the-browser). Read more [about proxy fetchers](/essentials/fetchers#using-fetchers-on-the-browser).
```ts ```ts
import { makeProviders, makeStandardFetcher, targets } from '@movie-web/providers'; import { makeProviders, makeStandardFetcher, targets } from '@movie-web/providers';
@@ -41,21 +41,24 @@ const providers = makeProviders({
## React native ## React native
To use the library in a react native app, you would also need a couple of polyfills to polyfill crypto and base64. To use the library in a react native app, you would also need a couple of polyfills to polyfill crypto and base64.
1. First install the polyfills: <Steps>
```bash <Steps.Step>
### First install the polyfills:
```sh npm2yarn
npm install @react-native-anywhere/polyfill-base64 react-native-quick-crypto npm install @react-native-anywhere/polyfill-base64 react-native-quick-crypto
``` ```
</Steps.Step>
2. Add the polyfills to your app: <Steps.Step>
### Add the polyfills to your app:
```ts ```ts
// Import in your entry file // Import in your entry file
import '@react-native-anywhere/polyfill-base64'; import '@react-native-anywhere/polyfill-base64';
``` ```
And follow the [react-native-quick-crypto documentation](https://github.com/margelo/react-native-quick-crypto) to set up the crypto polyfill. And follow the [react-native-quick-crypto documentation](https://github.com/margelo/react-native-quick-crypto) to set up the crypto polyfill.
</Steps.Step>
3. Then you can use the library like this: <Steps.Step>
### Then you can use the library like this:
```ts ```ts
import { makeProviders, makeStandardFetcher, targets } from '@movie-web/providers'; import { makeProviders, makeStandardFetcher, targets } from '@movie-web/providers';
@@ -65,3 +68,5 @@ const providers = makeProviders({
consistentIpForRequests: true, consistentIpForRequests: true,
}) })
``` ```
</Steps.Step>
</Steps>

View File

@@ -1,16 +1,16 @@
# Development / contributing # Development / contributing
::alert{type="warning"} <Warning>
This page isn't quite done yet, stay tuned! This page isn't quite done yet, stay tuned!
:: </Warning>
<!-- {/*
TODO TODO
- Development setup - Development setup
- How to make new sources/embeds (link to the page) - How to make new sources/embeds (link to the page)
- How to use the fetchers, when to use proxiedFetcher - How to use the fetchers, when to use proxiedFetcher
- How to use the context - How to use the context
--> */}
## Testing using the CLI ## Testing using the CLI
@@ -27,7 +27,7 @@ Then make sure you've run `npm i` to get all the dependencies.
To run the CLI without needing to learn all the arguments, simply run the following command and go with the flow. To run the CLI without needing to learn all the arguments, simply run the following command and go with the flow.
```sh ```sh npm2yarn
npm run cli npm run cli
``` ```
@@ -67,6 +67,6 @@ The CLI comes with a few built-in fetchers:
- `native` : Use the new fetch built into Node.JS (undici). - `native` : Use the new fetch built into Node.JS (undici).
- `browser` : Start up headless chrome, and run the library in that context using a proxied fetcher. - `browser` : Start up headless chrome, and run the library in that context using a proxied fetcher.
::alert{type="warning"} <Warning>
The browser fetcher will require you to run `npm run build` before running the CLI. Otherwise you will get outdated results. The browser fetcher will require you to run `npm run build` before running the CLI. Otherwise you will get outdated results.
:: </Warning>

View File

@@ -0,0 +1,3 @@
import { createRedirect } from '@neato/guider/client';
export default createRedirect({ to: '/in-depth/sources-vs-embeds' });

View File

@@ -102,9 +102,9 @@ title: 'Changelog'
# Version 2.0.0 # Version 2.0.0
::alert{type="warning"} <Warning>
There are breaking changes in this list, make sure to read them thoroughly if you plan on updating. There are breaking changes in this list, make sure to read them thoroughly if you plan on updating.
:: </Warning>
**Development tooling:** **Development tooling:**
- Added integration test for browser. To make sure the package keeps working in the browser - Added integration test for browser. To make sure the package keeps working in the browser

View File

@@ -0,0 +1,7 @@
---
title: 'Examples'
---
<Note>
Coming soon
</Note>

View File

@@ -0,0 +1,3 @@
import { createRedirect } from '@neato/guider/client';
export default createRedirect({ to: '/get-started/introduction' });

View File

@@ -1,4 +1,6 @@
# Introduction ---
title: 'Introduction'
---
## What is `@movie-web/providers` ? ## What is `@movie-web/providers` ?
@@ -11,4 +13,4 @@ We support many different environments, here are a few examples:
- In a native app, scrape in the app itself - In a native app, scrape in the app itself
- In a backend server, scrape on the server and give the streams to the client to watch. - In a backend server, scrape on the server and give the streams to the client to watch.
To find out how to configure the library for your environment, You can read [How to use on X](../2.essentials/0.usage-on-x.md). To find out how to configure the library for your environment, You can read [How to use on X](/essentials/usage-on-x).

View File

@@ -1,30 +1,24 @@
# Quick start ---
title: 'Quick Start'
---
## Installation ## Installation
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.
::code-group ```sh npm2yarn
```bash [NPM]
npm install @movie-web/providers npm install @movie-web/providers
``` ```
```bash [Yarn]
yarn add @movie-web/providers
```
```bash [PNPM]
pnpm install @movie-web/providers
```
::
## Scrape your first item ## Scrape your first item
To get started with scraping on the **server**, first you have to make an instance of the providers. To get started with scraping on the **server**, first you have to make an instance of the providers.
::alert{type="warning"} <Important>
This snippet will only work on a **server**. For other environments, check out [Usage on X](../2.essentials/0.usage-on-x.md). This snippet will only work on a **server**. For other environments, check out [Usage on X](/essentials/usage-on-x).
:: </Important>
```ts [index.ts (server)] ```ts title="index.ts (server)" showLineNumbers
import { makeProviders, makeStandardFetcher, targets } from '@movie-web/providers'; import { makeProviders, makeStandardFetcher, targets } from '@movie-web/providers';
// this is how the library will make http requests // this is how the library will make http requests
@@ -42,19 +36,36 @@ const providers = makeProviders({
Perfect. You now have an instance of the providers you can reuse everywhere. Perfect. You now have an instance of the providers you can reuse everywhere.
Now let's scrape an item: Now let's scrape an item:
```ts [index.ts (server)] ```ts title="index.ts (server)" showLineNumbers
// fetch some data from TMDB import { ScrapeMedia, makeProviders, makeStandardFetcher, targets } from '@movie-web/providers';
const media = {
const myFetcher = makeStandardFetcher(fetch);
const providers = makeProviders({
fetcher: myFetcher,
target: targets.NATIVE
});
const media: ScrapeMedia = {
type: 'movie', type: 'movie',
title: "Hamilton", title: "Oppenheimer",
releaseYear: 2020, releaseYear: 2023,
tmdbId: "556574" tmdbId: "872585"
};
async function fetchData() {
try {
const output = await providers.runAll({
media: media,
});
console.log("Output:",output)
} catch (error) {
console.error('Error occurred:', error);
}
} }
const output = await providers.runAll({ fetchData();
media: media
})
``` ```
Now we have our stream in the output variable. (If the output is `null` then nothing could be found.) Now we have our stream in the output variable. (If the output is `null` then nothing could be found.)
To find out how to use the streams, check out [Using streams](../2.essentials/4.using-streams.md). To find out how to use the streams, check out [Using streams](/essentials/using-streams).

View File

@@ -0,0 +1,3 @@
import { createRedirect } from '@neato/guider/client';
export default createRedirect({ to: '/in-depth/sources-vs-embeds' });

View File

@@ -1,12 +1,12 @@
# New providers # New providers
::alert{type="warning"} <Warning>
This page isn't quite done yet, stay tuned! This page isn't quite done yet, stay tuned!
:: </Warning>
<!-- {/*
TODO TODO
- How to make new sources or embeds - How to make new sources or embeds
- Ranking - Ranking
- Link to flags - Link to flags
--> */}

View File

@@ -1,11 +1,11 @@
# Sources vs embeds # Sources vs embeds
::alert{type="warning"} <Warning>
This page isn't quite done yet, stay tuned! This page isn't quite done yet, stay tuned!
:: </Warning>
<!-- {/*
TODO TODO
- How do sources and embeds differ - How do sources and embeds differ
- How do sources and embeds interact - How do sources and embeds interact
--> */}

42
.docs/pages/index.tsx Normal file
View File

@@ -0,0 +1,42 @@
import {
Button,
Card,
CardGrid,
GuiderLayout,
Hero,
} from '@neato/guider/client';
export default function LandingPage() {
return (
<GuiderLayout meta={{ layout: 'page' }}>
<Hero>
<Hero.Badge title="V2.3.0" to="/get-started/changelog">
See changelog for more
</Hero.Badge>
<Hero.Title>@movie-web/providers</Hero.Title>
<Hero.Subtitle>
Easily scrape all sorts of media sites for content.
</Hero.Subtitle>
<Hero.Actions>
<Button to="/get-started/introduction">Get Started</Button>
<Button to="https://github.com/movie-web/providers" type="secondary">
Open on GitHub
</Button>
</Hero.Actions>
</Hero>
<CardGrid>
<Card icon="mdi:code-json" title="Scrape popular streaming websites.">
Don&apos;t settle for just one media site for you content, use
everything that&apos;s available.
</Card>
<Card icon="mdi:git" title="Multi-platform.">
Scrape from browser or server, whichever you prefer.
</Card>
<Card icon="mdi:language-typescript" title="Easy to use.">
Get started with scraping your favourite media sites with just 5 lines
of code. Fully typed of course.
</Card>
</CardGrid>
</GuiderLayout>
);
}

10064
.docs/pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

Binary file not shown.

After

Width:  |  Height:  |  Size: 887 KiB

BIN
.docs/public/cover.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 328 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

BIN
.docs/public/icon-dark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
.docs/public/icon-light.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

View File

@@ -1,8 +0,0 @@
{
"extends": [
"@nuxtjs"
],
"lockFileMaintenance": {
"enabled": true
}
}

112
.docs/theme.config.tsx Normal file
View File

@@ -0,0 +1,112 @@
import { defineTheme, directory, group, link, social } from '@neato/guider/theme';
import { Logo } from './components/Logo';
import { NextSeo } from 'next-seo';
import coverUrl from "./public/cover.png";
import faviconUrl from "./public/favicon.ico";
export default defineTheme({
github: "movie-web/providers",
contentFooter: {
text: "Made with 💜",
editRepositoryBase: "https://github.com/movie-web/providers",
socials: [
social.github("https://github.com/movie-web/providers"),
social.discord("https://movie-web.github.io/links/discord"),
]
},
meta: (pageMeta) => (
<NextSeo {...{
title: `${pageMeta.title ?? "For all your media scraping needs"} | movie-web`,
description: pageMeta.description ?? "movie-web/providers : Easily scrape all sorts of media sites for content.",
openGraph: {
images: [{
url: coverUrl.src,
}],
title: `${pageMeta.title ?? "For all your media scraping needs"} | movie-web`,
description: pageMeta.description ?? "movie-web/providers : Easily scrape all sorts of media sites for content.",
},
twitter: {
cardType: 'summary_large_image',
},
additionalLinkTags: [
{
href: faviconUrl.src,
rel: "icon",
type: "image/x-icon",
}
]
}} />
),
settings: {
logo: () => <Logo />,
colors: {
primary: "#E67070",
primaryLighter: "#E59595",
primaryDarker: "#D21818",
background: "#000000",
backgroundLighter: "#141414",
backgroundLightest: "#292929",
backgroundDarker: "#000000",
line: "#404040",
text: "#B3B3B3",
textLighter: "#CCCCCC",
textHighlight: "#cccccc",
codeWarning: '#222D20',
codeError: '#2B1B1F',
codeGreen: '#0B2823',
codeHighlight: '#0E2429',
codeWordHighlight: '#365C68',
semanticTip: '#39B864',
semanticTipLighter: '#75F2B6',
semanticNote: '#817EF3',
semanticNoteLighter: '#B9B8FC',
semanticImportant: '#A958E8',
semanticImportantLighter: '#D3A2F9',
semanticWarning: '#fff708',
semanticWarningLighter: '#faf8b1',
semanticCaution: '#FC6359',
semanticCautionLighter: '#FFA59F',
},
backgroundPattern: 'flare',
},
directories: [
directory("main", {
sidebar: [
group("Get Started", [
link("Introduction", "/get-started/introduction"),
link("Quickstart", "/get-started/quick-start"),
link("Examples", "/get-started/examples"),
link("Changelog", "/get-started/changelog"),
]),
group("Essentials", [
link("Usage on X", "/essentials/usage-on-x"),
link("Targets", "/essentials/targets"),
link("Fetchers", "/essentials/fetchers"),
link("Customize Providers", "/essentials/customize-providers"),
link("Using Streams", "/essentials/using-streams"),
]),
group("In Depth", [
link("Sources vs Embeds", "/in-depth/sources-vs-embeds"),
link("New Providers", "/in-depth/new-providers"),
link("Flags", "/in-depth/flags"),
]),
group("Extra Topics", [
link("Development and Contributing", "/extra-topics/development"),
]),
group("Api Reference", [
link("makeProviders", "/api-reference/makeProviders"),
link("ProviderControls.runAll", "/api-reference/ProviderControlsRunAll"),
link("ProviderControls.runSourceScraper", "/api-reference/ProviderControlsrunSourceScraper"),
link("ProviderControls.runEmbedScraper", "/api-reference/ProviderControlsrunEmbedScraper"),
link("ProviderControls.listSources", "/api-reference/ProviderControlslistSources"),
link("ProviderControls.listEmbeds", "/api-reference/ProviderControlslistEmbeds"),
link("ProviderControls.getMetadata", "/api-reference/ProviderControlsgetMetadata"),
link("makeStandardFetcher", "/api-reference/makeStandardFetcher"),
link("makeSimpleProxyFetcher", "/api-reference/makeSimpleProxyFetcher"),
])
]
})
],
});

View File

@@ -1,18 +0,0 @@
import { defineTheme } from 'pinceau'
export default defineTheme({
color: {
primary: {
50: "#F5E5FF",
100: "#E7CCFF",
200: "#D4A9FF",
300: "#BE85FF",
400: "#A861FF",
500: "#8E3DFF",
600: "#7F36D4",
700: "#662CA6",
800: "#552578",
900: "#441E49"
}
}
})

View File

@@ -1,3 +1,28 @@
{ {
"extends": "./.nuxt/tsconfig.json" "compilerOptions": {
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"strict": false,
"noEmit": true,
"incremental": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "Bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve"
},
"include": [
"next-env.d.ts",
"**/*.ts",
"**/*.tsx"
],
"exclude": [
"node_modules"
]
} }