Skip to content

Commit

Permalink
revert: Diagram in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
matvp91 committed Aug 28, 2024
1 parent 52ff73c commit c3f22ef
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 697 deletions.
4 changes: 2 additions & 2 deletions packages/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { withMermaid } from "vitepress-plugin-mermaid";
import { defineConfig } from "vitepress";

export default withMermaid({
export default defineConfig({
base: "/mixwave/",
title: "Mixwave",
description: "A friendly API to simplify the complexities of video delivery.",
Expand Down
18 changes: 0 additions & 18 deletions packages/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,6 @@ Mixwave is a self hostable platform that aims to simplify the complexities of vi

Things get more complicated once you go beyond playing a basic <Badge type="info" text=".mp4" /> file. To offer different video qualities depending on the viewer's bandwidth, or to include multiple audio or text tracks, you need a different setup.

```mermaid
%%{init: {'theme': 'neutral' }}%%
flowchart LR
subgraph S2[ ]
direction TB
T(<img src="/mixwave/transcode.svg" width="25" height="25" /> Transcode) --> S1
end
subgraph S1[ ]
direction LR
TR1(1080p <small>3Mbps</small>)
TR2(720p <small>2Mbps</small>)
TR3(480p <small>1Mbps</small>)
end
R(<img src="/mixwave/raw.svg" width="25" height="25" /> Raw files) --> S2 --> P(<img src="/mixwave/package.svg" width="25" height="25" /> Package<br /><small>master.m3u8</small>) --> PO(<img src="/mixwave/publish.svg" width="25" height="25" /> Publish)
```

Before we go further, it's important to note that Mixwave intentionally keeps its scope limited. We choose to focus on a single playback protocol <Badge type="info" text="HLS CMAF" /> rather than trying to support a wide range of options.

## Features
Expand Down
9 changes: 1 addition & 8 deletions packages/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,7 @@
"private": true,
"version": "0.0.0",
"devDependencies": {
"@braintree/sanitize-url": "^7.1.0",
"cytoscape": "^3.30.2",
"cytoscape-cose-bilkent": "^4.1.0",
"dayjs": "^1.11.13",
"debug": "^4.3.6",
"mermaid": "^11.0.2",
"vitepress": "^1.3.2",
"vitepress-plugin-mermaid": "^2.0.16"
"vitepress": "^1.3.2"
},
"scripts": {
"dev": "vitepress dev",
Expand Down
Loading

0 comments on commit c3f22ef

Please sign in to comment.