Skip to content

Commit 8fd723b

Browse files
rajat1saxenarajat1saxena
committed
Added some docs
1 parent cb53d77 commit 8fd723b

22 files changed

+215
-64
lines changed

apps/docs/public/icon.svg renamed to apps/docs/app/icon.svg

File renamed without changes.

‎apps/docs/app/layout.config.tsx‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ export const baseOptions: BaseLayoutProps = {
1313
title: (
1414
<>
1515
{/* <svg
16-
width="24"
17-
height="24"
18-
xmlns="http://www.w3.org/2000/svg"
19-
aria-label="Logo"
20-
>
21-
<circle cx={12} cy={12} r={12} fill="currentColor" />
22-
</svg> */}
23-
<Image src="/icon.svg" alt="Logo" width={24} height={24} />
24-
My App
16+
width="24"
17+
height="24"
18+
xmlns="http://www.w3.org/2000/svg"
19+
aria-label="Logo"
20+
>
21+
<circle cx={12} cy={12} r={12} fill="currentColor" />
22+
</svg> */}
23+
<Image src="./icon.svg" alt="Logo" width={24} height={24} />
24+
MediaLit Docs
2525
</>
2626
),
2727
},
@@ -32,4 +32,5 @@ export const baseOptions: BaseLayoutProps = {
3232
// active: "nested-url",
3333
// },
3434
],
35+
githubUrl: "https://github.com/codelitdev/medialit",
3536
};

‎apps/docs/content/docs/express-js.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Express
3+
description: Integrate MediaLit with Express
4+
---
5+
6+
Coming soon

‎apps/docs/content/docs/faqs.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Frequently asked questions
3+
description: You asked, we answered
4+
---
5+
6+
#### Is MediaLit just a wrapper on top of the AWS S3 API?
7+
8+
No! It offers much more, like ease of use, image optimization, thumbnail creation, etc.
9+
10+
#### Can I build a MediaLit alternative in a weekend, since I am a developer?
11+
12+
You can always try. That said, we've already done all the heavy lifting for you, so you can add file uploads to your app in under 5 minutes. If time is NOT money, knock yourself out.
13+
14+
<Callout title="Still not sold?">
15+
Read [why](/what-is-medialit) we created MediaLit in the first place.
16+
</Callout>
17+
18+
#### Is the MediaLit OSS crippled in any way?
19+
20+
No! Everything that powers [medialit.cloud](https://medialit.cloud) is contained in our GitHub [repo](https://github.com/codelitdev/medialit).

‎apps/docs/content/docs/index.mdx‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
---
2-
title: Hello World
3-
description: Your first document
2+
title: MediaLit
3+
description: Effortless file uploads, optimization, and delivery.
44
---
55

6-
Welcome to the docs! You can start writing documents in `/content/docs`.
6+
Add file uploads to your apps in under 5 minutes.
77

8-
## What is Next?
8+
## Features
9+
- A simpler API for uploading files
10+
- Delivery through a CDN
11+
- Public/private files
12+
- Automatic image optimization (configurable)
13+
- Automatic thumbnail generation for images and videos (configurable)
14+
- Unlimited uploads/downloads
915

10-
<Cards>
11-
<Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
12-
<Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
13-
</Cards>
16+
## Getting started
17+
18+
You'll be off to the races in no time. Have a look at our [quick start](/quick-start).

‎apps/docs/content/docs/meta.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"title": "Meta",
3+
"pages": [
4+
"---Introduction---",
5+
"quick-start",
6+
"what-is-medialit",
7+
"---Getting started---",
8+
"next-app-router",
9+
"next-pages-router",
10+
"express-js",
11+
"rest-api",
12+
"---Resources---",
13+
"self-hosting",
14+
"faqs"
15+
]
16+
}

‎apps/docs/content/docs/next-app-router.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Nextjs App Router
3+
description: Integrate MediaLit with Nextjs App Router
4+
---
5+
6+
Coming soon

‎apps/docs/content/docs/next-pages-router.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Nextjs Pages Router
3+
description: Integrate MediaLit with Nextjs Pages Router
4+
---
5+
6+
Coming soon

‎apps/docs/content/docs/quick-start.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Quick Start
3+
description: Getting started with MediaLit
4+
icon: Album
5+
---
6+
7+
## Introduction
8+
9+
[MediaLit](https://medialit.cloud) offers **file hosting** along with other niceties like **image optimization** and **thumbnail generation**.
10+
11+
<Callout title="Want to learn more?">
12+
Read our in-depth [What is MediaLit](/what-is-medialit) introduction.
13+
</Callout>
14+
15+
## Getting started
16+
17+
You have to create an app on [MediaLit dashboard](https://app.medialit.cloud) and obtain the API key to the app in order to start uploading.
18+
19+
Once you have the API key, select your framework from below OR simply use our REST API to start uploading to MediaLit.
20+
21+
## Pick your framework
22+
23+
### Frontend frameworks
24+
25+
<Cards>
26+
<Card title="Nextjs App Router" href="/next-app-router" icon={<img src="/icons/nextjs.svg" width={24} height={24} style={{backgroundColor: 'white'}} alt="Nextjs icon"/>} />
27+
<Card title="Nextjs Pages Router" href="/next-pages-router" icon={<img src="/icons/nextjs.svg" width={24} height={24} style={{backgroundColor: 'white'}} alt="Nextjs icon"/>} />
28+
</Cards>
29+
30+
### Backend frameworks
31+
32+
<Cards>
33+
<Card title="Express" href="/express-js" icon={<img src="/icons/express.svg" width={24} height={24} style={{backgroundColor: 'white'}} alt="Express icon" />} />
34+
</Cards>
35+
36+
### Un-supported framework or language?
37+
38+
Our REST API is well documented and is easy to use. Write your own wrapper or go full CURL mode.
39+
40+
<Cards>
41+
<Card title="REST API" href="/rest-api" icon={<img src="/icons/rest-api.svg" width={24} height={24} style={{backgroundColor: 'white'}} alt="REST API icon" />} />
42+
</Cards>

‎apps/docs/content/docs/rest-api.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: REST API
3+
description: Integrate MediaLit with your app using our REST API
4+
---
5+
6+
We offer an official [Postman](https://postman.com) collection. The collection contains all the relevant documenation.
7+
8+
[MediaLit Postman collection](https://www.postman.com/dark-rocket-625879/codelit/collection/5b8hfkr/medialit)
9+
10+
## Video Tutorial
11+
12+
<iframe width="560" height="315" src="https://www.youtube.com/embed/QrYn82zK4es?si=eXrDWSGcSaSodYCY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

0 commit comments

Comments
 (0)