Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add updates to the Docker section of docs #59

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Add updates to the Docker section of docs #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 49 additions & 2 deletions website/src/routes/[[slug]]/Docker.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,62 @@
Now you can access Unfold endpoints.
</p>

<h2 id="endpoints">Endpoints</h2>

<h3>Unfold Endpoint</h3>

<CodeBlock
language='ts'
code={`
http://127.0.0.1:7272/unfold?url=https://hyvor.com.com&method=link
Method: GET
URL: 'http://127.0.0.1:7272/unfold'

Query Parameters:
url: string
method: link | embed | null // default: link

Response:
{
url: string,
lastUrl: string,
title: string | null,
description: string | null,
siteName: string | null,
siteUrl: string | null,
canonicalUrl: string | null,
publishedTime: string | null,
modifiedTime: string | null,
thumbnailUrl: string | null,
iconUrl: string | null,
locale: string | null,
authors: string[],
tags: string[],
durationMs: number
}

Example: 'http://127.0.0.1:7272/unfold?url=https://hyvor.com.com&method=link'
`}
/>

<h3>Iframe Endpoint</h3>

<CodeBlock
language='ts'
code={`
http://127.0.0.1:7272/iframe?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ
Method: GET
URL: 'http://127.0.0.1:7272/iframe'

Query Parameters:
url: string

Response:
{
url: string,
embed: string,
durationMs: number
}

Example: 'http://127.0.0.1:7272/iframe?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ'
`}
/>

Expand Down
Loading