Skip to content

Commit a68b1ee

Browse files
committed
chore: Added icons to docs
1 parent c3f22ef commit a68b1ee

File tree

10 files changed

+186
-38
lines changed

10 files changed

+186
-38
lines changed
Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1-
.image-rounded {
2-
border-radius: 8px;
1+
:root {
2+
--vp-c-brand-1: #7600ff;
3+
--vp-c-brand-2: #7600ff;
4+
--vp-c-brand-3: #7600ff;
5+
}
6+
7+
.logo {
8+
width: 96px;
9+
}
10+
11+
.hidden {
12+
display: none;
13+
}
14+
15+
.VPHero .name {
16+
line-height: 0px;
17+
}
18+
19+
.title-image {
20+
display: inline-block;
21+
width: 30px;
22+
margin-bottom: -6px;
23+
margin-right: 2px;
324
}

packages/docs/features/dashboard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Typically, you'd want to build the dashboard once and upload it to `S3` to serve
66

77
You can use the API docs to `Test Request`.
88

9-
<img src="../assets/dashboard-api.png" alt="Dashboard API" class="image-rounded" />
9+
<img src="../assets/dashboard-api.png" alt="Dashboard API" />
1010

1111
Each job, or child job, has detailed logs.
1212

13-
<img src="../assets/dashboard-job.png" alt="Dashboard job" class="image-rounded" />
13+
<img src="../assets/dashboard-job.png" alt="Dashboard job" />

packages/docs/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,19 @@
33
layout: home
44

55
hero:
6-
name: "Mixwave"
7-
text: "Convert, package and manipulate your video on the fly."
6+
name: <img class="logo" src="/mixwave/logo.svg" /> <span class="hidden">Mixwave</span>
7+
text: "Convert, package and manipulate on the fly."
88
tagline: "A friendly API to simplify the complexities of video delivery."
99
actions:
1010
- theme: brand
11-
text: Documentation
11+
text: Introduction
1212
link: /introduction
1313
- theme: alt
1414
text: Getting Started
1515
link: /getting-started
16+
- theme: alt
17+
text: GitHub
18+
link: https://github.com/matvp91/mixwave
1619

1720
features:
1821
- title: Transcode

packages/docs/introduction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before we go further, it's important to note that Mixwave intentionally keeps it
1616

1717
Mixwave makes it easier for you to do the following tasks using a user-friendly API:
1818

19-
### 1. Transcode
19+
### <img src="/transcode.svg" class="title-image" /> Transcode
2020

2121
The process of converting a video file from one format or codec to another. The [transcode](/features/transcode) job generates video, audio and text fragments from your sources and uploads them to `S3`. We ensure proper keyframes are in place for packaging purposes.
2222

@@ -27,7 +27,7 @@ The process of converting a video file from one format or codec to another. The
2727
Consider the result of a transcode job as an intermediate format ready for packaging.
2828
:::
2929

30-
### 2. Package
30+
### <img src="/package.svg" class="title-image" /> Package
3131

3232
The process of preparing and organizing video files for delivery and playback over various streaming platforms and devices. Packaging isn't as resource intensive as transcoding. The [package](/features/package) job generates an HLS playlist from the output of a transcode job. Basically, it comes down to the following steps:
3333

@@ -46,7 +46,7 @@ As with transcode, the end result will be uploaded to your configured `S3` bucke
4646
At this point, your stream can be played by HLS-compatible players, such as [HLS.js](https://github.com/video-dev/hls.js), or natively on Apple devices.
4747
:::
4848

49-
### 3. Stitch
49+
### <img src="/stitch.svg" class="title-image" /> Stitch
5050

5151
At this point, you've created playable assets. Stitching involves serving the manifest through a proxy that can modify the output based on different parameters. If you're looking to dynamically merge manifests, stitch them together, or add interstitials, this is for you.
5252

packages/docs/public/logo.svg

Lines changed: 26 additions & 0 deletions
Loading

packages/docs/public/package.svg

Lines changed: 26 additions & 8 deletions
Loading

packages/docs/public/publish.svg

Lines changed: 25 additions & 4 deletions
Loading

packages/docs/public/raw.svg

Lines changed: 25 additions & 5 deletions
Loading

packages/docs/public/stitch.svg

Lines changed: 25 additions & 6 deletions
Loading

0 commit comments

Comments
 (0)