create-unmint 1.3.4 → 1.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/template/README.md +19 -54
package/package.json
CHANGED
package/template/README.md
CHANGED
|
@@ -1,70 +1,35 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## What is Unmint?
|
|
8
|
-
|
|
9
|
-
Unmint provides a beautiful, customizable documentation experience similar to [Mintlify](https://mintlify.com), but completely free and open source. It's designed to be forked, customized, and self-hosted.
|
|
10
|
-
|
|
11
|
-
### Features
|
|
12
|
-
|
|
13
|
-
- **Beautiful out-of-the-box** - Professional styling without configuration
|
|
14
|
-
- **MDX Components** - Cards, callouts, tabs, steps, accordions, and more
|
|
15
|
-
- **Built-in Search** - Full-text search powered by Fumadocs
|
|
16
|
-
- **Dynamic OG Images** - Auto-generated social preview images
|
|
17
|
-
- **Dark Mode** - Seamless light/dark theme switching
|
|
18
|
-
- **Easy Theming** - Single config file for all customization
|
|
19
|
-
- **SEO Optimized** - Automatic meta tags and sitemap
|
|
20
|
-
|
|
21
|
-
### What Unmint is NOT
|
|
22
|
-
|
|
23
|
-
- A hosted SaaS (you deploy it yourself)
|
|
24
|
-
- A replacement for all Mintlify features (no built-in analytics, AI search, etc.)
|
|
25
|
-
- A no-code solution (basic Next.js knowledge helpful)
|
|
26
|
-
|
|
27
|
-
## Quick Start
|
|
3
|
+
<img src="public/logo.svg" alt="unmint logo" width="80" />
|
|
28
4
|
|
|
29
|
-
|
|
5
|
+
# unmint
|
|
30
6
|
|
|
31
|
-
|
|
32
|
-
- npm, yarn, or pnpm
|
|
7
|
+
### Beautiful docs. Zero cost. Full control.
|
|
33
8
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
The fastest way to get started is with our CLI:
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
npx create-unmint@latest my-docs
|
|
40
|
-
```
|
|
9
|
+
A free, open-source Mintlify-style documentation system built with Next.js and Fumadocs.
|
|
41
10
|
|
|
42
|
-
|
|
11
|
+
[](https://www.npmjs.com/package/create-unmint)
|
|
12
|
+
[](LICENSE)
|
|
13
|
+
[](https://unmint.dev/docs)
|
|
43
14
|
|
|
44
|
-
|
|
15
|
+
</div>
|
|
45
16
|
|
|
46
|
-
|
|
47
|
-
# Create with all defaults (no prompts)
|
|
48
|
-
npx create-unmint@latest my-docs --yes
|
|
17
|
+
## Features
|
|
49
18
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
19
|
+
- **Beautiful out-of-the-box** — Professional styling without configuration
|
|
20
|
+
- **MDX Components** — Cards, callouts, tabs, steps, accordions, and more
|
|
21
|
+
- **Built-in Search** — Full-text search powered by Fumadocs
|
|
22
|
+
- **Dynamic OG Images** — Auto-generated social preview images
|
|
23
|
+
- **Dark Mode** — Seamless light/dark theme switching
|
|
24
|
+
- **Easy Theming** — Single config file for all customization
|
|
25
|
+
- **SEO Optimized** — Automatic meta tags and sitemap
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
> **Note:** Unmint is self-hosted, not a SaaS. You own everything and deploy it yourself.
|
|
56
28
|
|
|
57
|
-
|
|
29
|
+
## Quick Start
|
|
58
30
|
|
|
59
31
|
```bash
|
|
60
|
-
# Clone the repository
|
|
61
|
-
git clone https://github.com/gregce/unmint.git my-docs
|
|
62
|
-
cd my-docs
|
|
63
|
-
|
|
64
|
-
# Install dependencies
|
|
65
32
|
npm install
|
|
66
|
-
|
|
67
|
-
# Start development server
|
|
68
33
|
npm run dev
|
|
69
34
|
```
|
|
70
35
|
|