@next-md-blog/core 1.0.0 → 1.0.1
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/README.md +8 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @next-md-blog/core
|
|
2
2
|
|
|
3
3
|
A powerful React library for parsing and displaying markdown and MDX blog posts in Next.js projects. Write your blog posts in markdown or MDX format and easily display them with dynamic routes, complete SEO optimization, and beautiful Open Graph images.
|
|
4
4
|
|
|
@@ -15,7 +15,7 @@ A powerful React library for parsing and displaying markdown and MDX blog posts
|
|
|
15
15
|
## 📦 Installation
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
npm install @
|
|
18
|
+
npm install @next-md-blog/core
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## 🚀 Quick Start
|
|
@@ -25,7 +25,7 @@ npm install @florianamette/next-md-blog
|
|
|
25
25
|
The easiest way to get started is using the CLI:
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
npx @
|
|
28
|
+
npx @next-md-blog/cli
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
This will automatically:
|
|
@@ -40,13 +40,13 @@ If you prefer manual setup:
|
|
|
40
40
|
|
|
41
41
|
1. **Install the package:**
|
|
42
42
|
```bash
|
|
43
|
-
npm install @
|
|
43
|
+
npm install @next-md-blog/core @tailwindcss/typography
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
2. **Create a config file:**
|
|
47
47
|
```tsx
|
|
48
48
|
// next-md-blog.config.ts
|
|
49
|
-
import { createConfig } from '@
|
|
49
|
+
import { createConfig } from '@next-md-blog/core';
|
|
50
50
|
|
|
51
51
|
export default createConfig({
|
|
52
52
|
siteName: 'My Blog',
|
|
@@ -60,8 +60,8 @@ export default createConfig({
|
|
|
60
60
|
3. **Create blog routes:**
|
|
61
61
|
```tsx
|
|
62
62
|
// app/blog/[slug]/page.tsx
|
|
63
|
-
import { getBlogPost, getAllBlogPosts, generateBlogPostMetadata } from '@
|
|
64
|
-
import { MarkdownContent } from '@
|
|
63
|
+
import { getBlogPost, getAllBlogPosts, generateBlogPostMetadata } from '@next-md-blog/core';
|
|
64
|
+
import { MarkdownContent } from '@next-md-blog/core';
|
|
65
65
|
import { notFound } from 'next/navigation';
|
|
66
66
|
import type { Metadata } from 'next';
|
|
67
67
|
import blogConfig from '@/next-md-blog.config';
|
|
@@ -237,6 +237,6 @@ MIT
|
|
|
237
237
|
## 🔗 Links
|
|
238
238
|
|
|
239
239
|
- [GitHub Repository](https://github.com/florianamette/next-mdx-blog)
|
|
240
|
-
- [CLI Package](https://www.npmjs.com/package/@
|
|
240
|
+
- [CLI Package](https://www.npmjs.com/package/@next-md-blog/cli)
|
|
241
241
|
- [Issues](https://github.com/florianamette/next-mdx-blog/issues)
|
|
242
242
|
|