Next.js项目App目录如何简单集成markdown博客

文章原文：Next.js项目App目录如何简单集成markdown博客
此教程适用于比较简单的项目实现，如果你是刚入门next，并且不想用太复杂的方式去实现一个博客项目，那么这个教程就挺适合你的。
Next.js官方关于markdown的文档有说明过如何渲染markdown，也是针对App目录的，但我尝试过并不太行，可能是版本的问题，不管怎么样，最后我并没有解决这个问题，而是用了别的方案去实现。
此教程适用于app目录的next项目，下面的例子刚好是多语言结构的项目。
实现思路

结合文件结构解说一下大致逻辑：

Markdown文件放在/app/_articles/[lang]文件夹下管理，如果你是多语言目录，那么每个语种都是单独一个文件夹，如果不是，那么可以直接放在/app/_articles文件夹下。
另外markdown文件里从第一行开始可以放入一些Frontmatter，一般放在文件开头，用---符号分割开，提供一些额外信息，如发布时间、更新时间，是否已经发布，对应的描述，这类的信息可以自定义的，方便你做很多个性化的操作，一般我用来做meta信息的填充。
这里可以给一些Frontmatter的例子：

1. ---
2. title: "这是博客标题"
3. createdAt: "2024-11-12"
4. updatedAt: "2024-11-12"
5. isPublished: true
6. description: "这是博客描述"
7. ---

复制代码

随着你文件的增多，你需要一些代码来管理、显示你的markdown信息，比如：

• 在你的blog页面展示所有的markdown博客。
  
• 根据markdown文件名称跳转对应的博客详情，比如访问https://i18ncode.com/blog/how-nextjs-app-simply-make-i18n 能正常显示how-nextjs-app-simply-make-i18n.mdx文件内的文本。
  
• 渲染markdown文本，当然要包括对应页面的meta信息。
  

具体代码

大致要做的事情如上所述，下面贴对应的代码。
先封装好一些通用方法在/lib/mdx.ts文件中，方便后续调用：

1. // mdx.ts
3. import fs from "fs";
4. import path from "path";
5. import matter from "gray-matter";
6. import readingTime from "reading-time";
8. const articlesDirectory = path.join(process.cwd(), "app/_articles");
9. const webContentDirectory = path.join(process.cwd(), "app/_contents");
11. // 获取 MDX/MD 原始数据
12. export function getMdxRawData(fileName: string, lang: string, hasSuffix: boolean) {
13.     let fullPath = path.join(articlesDirectory, lang, `${fileName}`);
14.     let suffix = hasSuffix // 判断是否有后缀，没有的话就加上后缀
15.         ? ""
16.         : fs.existsSync(`${fullPath}.mdx`)
17.             ? ".mdx"
18.             : ".md";
19.     const fileContents = fs.readFileSync(`${fullPath}${suffix}`, "utf8");
20.     return fileContents;
21. }
23. // 处理 MDX/MD 原始数据中的 frontmatter
24. export function getMdxFrontmatter(mdxRawData: string) {
25.     const { content, data } = matter(mdxRawData);
26.     return {
27.         content,
28.         frontmatter: data,
29.         readingTime: readingTime(content).text, // 计算阅读时间
30.     };
31. }
33. // 获取文章的所有信息
34. export function getArticlesData(fileName: string, lang: string, hasSuffix = false) {
35.     return {
36.         ...getMdxFrontmatter(getMdxRawData(fileName, lang, hasSuffix)),
37.         fileName: fileName.split(".").slice(0, -1).join("."), // 去除后缀
38.     };
39. }
41. // 获取 _articles 目录下的所有文章
42. export function getAllArticlesData(lang: string) {
43.     const fileNames = fs.readdirSync(articlesDirectory + "/" + lang);
44.     const allArticlesData = fileNames.map((fileName) => {
45.         return getArticlesData(fileName, lang,true);
46.     });
47.     return allArticlesData;
48. }

复制代码

你可以根据你项目的具体情况来调整上面的代码。
在你的blog页面展示所有的markdown博客

调用上面封装好的getAllArticlesData方法，该方法支持一个叫lang的参数，这是多语言项目里有的参数，如果你传入的值为en，那么它就会去/app/_articles/en下获取所有的markdown文件。
然后不要忘记按时间排序：

1. export default async function BlogPage({params: {lang}}: { params: { lang: Locale } }) {
2.     const allArticlesData = getAllArticlesData(lang);
3.     const dictionary = await getDictionary(lang);
4.     const sortedArticles = allArticlesData.sort((a, b) => {
5.         // 将日期字符串转换为日期对象
6.         const dateA = new Date(a.frontmatter.createdAt).getTime();
7.         const dateB = new Date(b.frontmatter.createdAt).getTime();
9.         // 比较日期，返回值决定排序
10.         return dateB - dateA; // 倒序排序
11.     });
12.     return (
13.         
14.             
15.                 <h1 className={title()}>{dictionary.blog.title}</h1>
16.                
17.                     {sortedArticles.map(article => (
18.                         <Blog blog={article} key={article.fileName} lang={lang} />
19.                     ))}
20.                
21.             
22.             <CallToAction dictionary={dictionary} />
23.         
24.     );
25. }

复制代码

根据markdown文件名称跳转对应的博客详情

Blog组件中使用简单的跳转：

1. [/code]将文件名传递过去，详情页面会根据文件名找到对应的文件进行渲染。
2. [size=5]渲染markdown文本[/size]
4. 在/app/[lang]/blog/[id]/page.tsx页面下则是对具体的markdown进行解析和渲染，将对应的内容填入页面，渲染meta信息：
5. [code]import { getArticlesData } from "@/lib/mdx";
6. import { Remarkable } from 'remarkable';
7. import hljs from 'highlight.js';
8. import {getDictionary} from "@/get-dictionaries";
9. import CallToAction from "@/components/cta";
10. import React from "react";
12. export const generateMetadata = async ({ params }: any) => {
13.     const { content, frontmatter, readingTime } = getArticlesData(params.id, params.lang);
14.     const lang = await getDictionary(params.lang);
15.     return {
16.         title: frontmatter.title + " | " + lang.blog.meta.title,
17.         description: frontmatter.description,
18.         openGraph: {
19.             title: frontmatter.title + " | " + lang.blog.meta.title,
20.             type: "website",
21.             url: ``,
22.             images: [
23.                 {
24.                     // 此处还可以有width和height属性，see:https://medium.com/@moh.mir36/open-graph-with-next-js-v13-app-directory-22c0049e2087
25.                     url: "/logo.png",
26.                     alt: ""
27.                 }
28.             ],
29.             siteName: "",
30.             description: frontmatter.description,
31.             locale: ""
32.         },
33.         twitter: {
34.             images: [
35.                 {
36.                     url: "/logo.png",
37.                     alt: ""
38.                 }
39.             ],
40.             title: frontmatter.title + " | " + lang.blog.meta.title,
41.             description: frontmatter.description,
42.             card: "summary_large_image"
43.         },
44.     }
45. }
46. // !important：博客的排版需要在tailwind.config.js中添加插件：require("@tailwindcss/typography")，自行查看对应代码
47. const Page = async ({ params }: any) => {
48.     const { content, frontmatter, readingTime } = getArticlesData(params.id, params.lang);
49.     const md = new Remarkable({
50.         html: true,
51.         breaks: true,
52.         linkify: true,
53.         typographer: true,
54.         highlight: function (str: string, lang: string) {
55.             if (lang && hljs.getLanguage(lang)) {
56.                 try {
57.                     return hljs.highlight(lang, str).value;
58.                 } catch (err) {}
59.             }
61.             try {
62.                 return hljs.highlightAuto(str).value;
63.             } catch (err) {
65.             }
67.             return ''; // use external default escaping
68.         }
69.     });
70.     const blog = md.render(content, frontmatter);
71.     const dictionary = await getDictionary(params.lang);
73.     return (
74.         <main className="container pb-24 text-start">
75.             
76.                
77.             
78.             <CallToAction dictionary={dictionary} />
79.         </main>
80.     );
81. };
82. export default Page;

复制代码

这里用了Remarkable方案代替了Next的MDXRemote组件。
到这里基本上完成了一半，但是样式方面可能会用欠缺，需要在tailwind.config.js中添加插件：require("@tailwindcss/typography")，代码如下：

1. import {nextui} from '@nextui-org/theme'
3. /** @type {import('tailwindcss').Config} */
4. module.exports = {
5.     //...
6.     plugins: [
7.         // ....
8.         require("@tailwindcss/typography"), // markdown typography
9.     ],
10. }

复制代码

OK，到这里基本大功告成，就可以正常显示了，当然，过程中需要安装一些依赖，根据你项目里缺的依赖来安装就可以了。
关于多语言Markdown文件的管理和翻译

你可以看到，使用这种方式，如果是多语言的站点，那么你不可避免地要翻译和管理好对应的markdown文件。
用gpt翻译的话长度会受限制，第一个语种还好，第二个语种之后就会开始忘记原文，然后就开始胡言乱语了；要么你就每次对话都带上原文让gpt翻译，这样对话没几轮就得开启一个新的对话了。
我刚开始做这类工作的时候完成一篇博客需要一整个下午的时间，这实在是太耗时了。
机器翻译更无法接受，它无法识别markdown的符号，会格式错乱，另外机翻效果略显生硬。
基于这块的考虑我做了个专门针对这种情况的翻译器，有需要的朋友可以体验一下markdown翻译器。
markdown翻译器考虑了长度问题，做了文本切割并分段请求，你可以把一整个markdown文本塞进去翻译，直接获取最后的整体结果，经过反复尝试我这是没什么问题的；另外也做了markdown格式的识别和保留，不用害怕丢失格式；最后也考虑了本土化的情况，同样的文本也尽量要求AI用更本土化的方式表达出来，应该是比较适合做国际化的朋友了。
最后，感谢你阅读到这里，博客处会时不时更新一些独立开发的技术分享，希望能为更多的开发者朋友提供一些工具以外的帮助吧。

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！