【React】使用Next.js构建并部署个人博客

简介: 【React】使用Next.js构建并部署个人博客

前言

关于博客系统,相信大家早已驾轻就熟,网上有很多以markdown驱动的博客框架,如vuepresshexo等,这类框架的本质是生成静态站点,而个人开发的博客系统大多是使用数据库的全栈项目,这两种方式各有各的好处,这里就不做比较了

这篇文章我们将自己独立去开发并部署一个以markdown驱动的静态站点博客,所用技术栈如下:

  • React
  • TypeScript
  • Next.js
  • tailwindcss
  • Vercel部署
注意: 本文只是演示使用 Next.js从0到1构建并部署一个个人博客项目,不会对项目构建过程中所用到的技术做详细的讲解,不过不用担心,只要跟着文章一步一步来,小白都能成功部署自己的个人博客!

项目仓库地址:https://github.com/Chen0807AiLJX/next-blog
最终效果可见:https://next-blog-eosin-six.vercel.app/

现在让我们开始吧!

开始之前请确保自己电脑上配置的有 Node.js 12.13.0 或更高版本。

1、创建Next.js项目

要创建 Next.js 应用程序,请打开终端,cd进入到要在其中创建应用程序的目录,然后运行以下命令:

npx create-next-app@latest --typescript ailjx-blog
上述代码表示:通过 create-next-app创建名为 ailjx-blogTypeScript版本的 Next.js应用程序

vscode打开ailjx-blog项目,目录结构如下:

在这里插入图片描述

在项目根目录终端运行以下命令启动项目

npm run dev

打开http://localhost:3000/显示如下页面:
在这里插入图片描述

2、安装tailwindcss

在项目根目录终端运行以下命令:

npm install -D tailwindcss@latest postcss@latest autoprefixer@latest

生成tailwindcss配置文件:

npx tailwindcss init -p 

此时项目里会多出两个文件:tailwind.config.jspostcss.config.js

修改tailwind.config.js文件里的content为:

    content: [
        "./pages/**/*.{js,ts,jsx,tsx}",
        "./components/**/*.{js,ts,jsx,tsx}",
        "./styles/**/*.css",
    ],

pages文件夹下的_app.tsx文件的第一行添加:

import "tailwindcss/tailwind.css";

之后重新启动项目

3、添加布局页面

准备一张自己的头像(建议比例为1:1,这里演示用的头像文件名为author.jpg

public文件夹下新建images文件夹,将你的头像图片放入其中,并删除public文件夹下的svg文件

public文件为项目的静态文件,可直接通过地址访问,如访问演示所用头像: http://localhost:3000/images/author.jpg

项目根目录下新建components文件夹,并添加布局文件layout.tsx

import Head from "next/head";
import Image from "next/image";
import Link from "next/link";

const name = "Ailjx"; // 名称,根据需要修改
export const siteTitle = "Ailjx Blog"; // 网站标题,根据需要修改

interface Props {
    children: React.ReactNode;
    home?: boolean;
}

export default function Layout({ children, home }: Props) {
    return (
        <div className='max-w-2xl mx-auto px-4 mt-12 mb-24'>
            <Head>
                <link rel='icon' href='/favicon.ico' />
                <meta name='description' content='AiljxBlog——Ailjx的博客' />
                <meta
                    property='og:image'
                    content={`https://og-image.vercel.app/${encodeURI(
                        siteTitle
                    )}.png?theme=light&md=0&fontSize=75px&images=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Ffront%2Fassets%2Fdesign%2Fnextjs-black-logo.svg`}
                />
                <meta name='og:title' content={siteTitle} />
                <meta name='twitter:card' content='summary_large_image' />
            </Head>
            <header className='flex flex-col items-center'>
                {home ? (
                    <>
                        <Image
                            priority
                            src='/images/author.jpg'
                            className='rounded-full'
                            height={144}
                            width={144}
                            alt={name}
                        />
                        <h1 className='text-5xl font-extrabold tracking-tighter my-4'>
                            {name}
                        </h1>
                    </>
                ) : (
                    <>
                        <Link href='/'>
                            <a>
                                <Image
                                    priority
                                    src='/images/author.jpg'
                                    className='rounded-full'
                                    height={108}
                                    width={108}
                                    alt={name}
                                />
                            </a>
                        </Link>
                        <h2 className='text-2xl my-4'>
                            <Link href='/'>
                                <a>{name}</a>
                            </Link>
                        </h2>
                    </>
                )}
            </header>
            <main>{children}</main>
            {!home && (
                <div className='mt-12'>
                    <Link href='/'>
                        <a>← 返回首页</a>
                    </Link>
                </div>
            )}
        </div>
    );
}

这里使用了几个Next自带的组件:

  • Head:向Html页面的head内添加内容,里面内容自己根据需要修改
  • Image:渲染图像的组件,src地址修改为自己头像的地址
  • Link :页面间跳转组件

4、新建markdown文章

项目根目录下新建posts文件夹,添加一个markdown文件,如:

欢迎来到我的博客.md

---
title: "欢迎来到我的博客"
date: "2022-08-08"
---

## 欢迎你!

注意: 需要在每个markdown文件的顶部通过---添加元数据,元数据需要有title字段表示文章标题,date字段表示日期,如上面欢迎来到我的博客.md的元数据为:

---
title: "欢迎来到我的博客"
date: "2022-08-08"
---

这些数据在我们渲染markdown内容时需要用到

5、解析markdown内容

需要安装以下插件:

  • remark-prism:代码高亮插件
  • date-fns:处理日期
  • gray-matter:获取元数据
  • next-mdx-remote:用于解析和渲染markdown内容
  • remark-external-links:对markdown内的链接添加reltarget,使其能够在新页面打开

在项目根目录终端运行以下命令安装上述插件:

 npm i remark-prism date-fns gray-matter next-mdx-remote remark-external-links
npm i @types/remark-prism --D

在项目根目录新建存放工具函数的utils文件夹,里面新建处理markdown文件的posts.ts

import fs from "fs";
import path from "path";
// gray-matter:获取元数据
import matter from "gray-matter";
// date-fns:处理日期
import { parseISO } from "date-fns";
import { serialize } from "next-mdx-remote/serialize";
// remark-prism:markdown代码高亮
import prism from "remark-prism";
// externalLinks:使markdown的链接是在新页面打开链接
import externalLinks from "remark-external-links";

interface MatterMark {
    data: { date: string; title: string };
    content: string;
    [key: string]: unknown;
}

// posts目录的路径
const postsDirectory = path.join(process.cwd(), "posts");
// 获取posts目录下的所有文件名(带后缀)
const fileNames = fs.readdirSync(postsDirectory);

// 获取所有文章用于展示首页列表的数据
export function getSortedPostsData() {
    // 获取所有md文件用于展示首页列表的数据,包含id,元数据(标题,时间)
    const allPostsData = fileNames.map((fileName) => {
        // 去除文件名的md后缀,使其作为文章id使用
        const id = fileName.replace(/\.md$/, "");

        // 获取md文件路径
        const fullPath = path.join(postsDirectory, fileName);

        // 读取md文件内容
        const fileContents = fs.readFileSync(fullPath, "utf8");

        // 使用matter提取md文件元数据:{data:{//元数据},content:'内容'}
        const matterResult = matter(fileContents);

        return {
            id,
            ...(matterResult.data as MatterMark["data"]),
        };
    });

    // 按照日期从进到远排序
    return allPostsData.sort(({ date: a }, { date: b }) =>
        // parseISO:字符串转日期
        parseISO(a) < parseISO(b) ? 1 : -1
    );
}

// 获取格式化后的所有文章id(文件名)
export function getAllPostIds() {
    // 这是返回的格式:
    // [
    //   {
    //     params: {
    //       id: '......'
    //     }
    //   },
    //   {
    //     params: {
    //       id: '......'
    //     }
    //   }
    // ]

    return fileNames.map((fileName) => {
        return {
            params: {
                id: fileName.replace(/\.md$/, ""),
            },
        };
    });
}

// 获取指定文章内容
export async function getPostData(id: string) {
    // 文章路径
    const fullPath = path.join(postsDirectory, `${id}.md`);

    // 读取文章内容
    const fileContents = fs.readFileSync(fullPath, "utf8");

    // 使用matter解析markdown元数据和内容
    const matterResult = matter(fileContents);

    return {
        content: await serialize(matterResult.content, {
            mdxOptions: { remarkPlugins: [prism, externalLinks] },
        }),
        ...(matterResult.data as MatterMark["data"]),
    };
}

posts.ts里有三个主要的函数:

  • getSortedPostsData:在首页用于展示文章列表
  • getAllPostIds:获取指定格式的所有文章id(文件名),这个格式是Next所要求的

    因为我们在写文章详情页面时需要使用动态路由,每个文章的 id就是一个路由,并且我们使用的 Next静态站点生成会在项目打包构建时直接生成 所有的 html文件,需要把每一个路由对应的页面都构建出来, Next会根据 getAllPostIds函数返回的这种格式的数据去构建每一个 html页面
  • getPostData:获取文章详情,在文章详情页面会用到

6、添加首页

首页会展示文章列表,会用到一个日期渲染组件,我们先创建一下

components文件夹下新建date.tsx文件:

import { parseISO, format } from "date-fns";

interface Props {
    dateString: string;
}

export default function Date({ dateString }: Props) {
    const date = parseISO(dateString);
    return (
        <time dateTime={dateString} className='text-gray-500'>
            {format(date, "yyyy年MM月dd日")}
        </time>
    );
}

修改pages文件夹下的index.tsx文件如下:

import type { NextPage, GetStaticProps } from "next";
import Head from "next/head";
import Layout, { siteTitle } from "../components/layout";
import Link from "next/link";
import Date from "../components/date";

import { getSortedPostsData } from "../utils/posts";

interface Props {
    allPostsData: {
        date: string;
        title: string;
        id: string;
    }[];
}

const Home: NextPage<Props> = ({ allPostsData }) => {
    return (
        <Layout home>
            <div>
                <Head>
                    <title>{siteTitle}</title>
                </Head>

                <section className='text-xl leading-normal text-center'>
                    <p>你好,我是 Ailjx</p>
                    <p>一个又菜又爱玩的前端小白,欢迎来到我的博客!</p>
                </section>

                <section className='text-xl leading-normal pt-4'>
                    <h2 className=' text-2xl my-4 font-bold'>Blog</h2>
                    <ul>
                        {allPostsData.map(({ id, date, title }) => (
                            <li key={id} className='mb-5'>
                                <Link href={`/posts/${id}`}>
                                    <a>{title}</a>
                                </Link>
                                <br />
                                <small>
                                    <Date dateString={date} />
                                </small>
                            </li>
                        ))}
                    </ul>
                </section>
            </div>
        </Layout>
    );
};

export const getStaticProps: GetStaticProps = async () => {
      // 获取文章列表
    const allPostsData = getSortedPostsData();

    return {
        props: {
            allPostsData,
        },
    };
};

export default Home;

修改styles文件夹下的globals.css如下:

a {
    color: #0070f3;
    text-decoration: none;
}

a:hover {
    text-decoration: underline;
}

img {
    max-width: 100%;
    display: block;
}
::-webkit-scrollbar {
    width: 5px;
    height: 5px;
    position: absolute;
}
::-webkit-scrollbar-thumb {
    background-color: #0070f3;
}
::-webkit-scrollbar-track {
    background-color: #ddd;
}

删除style文件夹下的Home.module.css

此时运行项目,打开http://localhost:3000/可见:
在这里插入图片描述

7、添加文章详情页面

pages文件夹下创建posts文件夹,在其中创建[id].tsx文件:

import type { GetStaticProps, GetStaticPaths } from "next";
import Layout from "../../components/layout";
import { getAllPostIds, getPostData } from "../../utils/posts";
import Head from "next/head";
import Date from "../../components/date";
import { MDXRemote, MDXRemoteProps } from "next-mdx-remote";
// 引入代码高亮css
import "prismjs/themes/prism-okaidia.min.css";

interface Props {
    postData: {
        title: string;
        date: string;
        content: MDXRemoteProps;
    };
}

export default function Post({ postData }: Props) {
    return (
        <Layout>
            <Head>
                <title>{postData.title}</title>
            </Head>
            <h1 className='text-3xl font-extrabold my-4 tracking-tighter'>
                {postData.title}
            </h1>

            <Date dateString={postData.date} />

            <article className='py-8 prose  prose-h1:mt-8'>
                <MDXRemote {...postData.content} />
            </article>
        </Layout>
    );
}

// getStaticProps和getStaticPaths只在服务器端运行,永远不会在客户端运行
export const getStaticPaths: GetStaticPaths = async () => {
    // 获取所有文章id,即所有路由
    const paths = getAllPostIds();
    return {
        paths,
        fallback: false,
    };
};

export const getStaticProps: GetStaticProps = async ({ params }) => {
    // 获取文章内容 
    const postData = await getPostData(params!.id as string);
    return {
        props: {
            postData,
        },
    };
};

之后在首页点击文章列表跳转到文章详情页面:
在这里插入图片描述
到此一个简单的博客项目就写好了

8、Vercel部署

没有 Github账号的先去注册一个账号

Github上新建一个名为next-blog的仓库(名称自己根据需要修改):

在这里插入图片描述

仓库权限公共私有都可,并且不需要使用 README 或其他文件对其进行初始化

在我们的博客项目根目录下运行以下命令推送代码到Github仓库里:

git remote add origin https://github.com/<username>/next-blog.git
git branch -M main
git push -u origin main

请将上述第一行命令origin后面的地址替换成你的仓库地址,一般是将<username>替换为你Gitub的用户名,next-blog替换成你仓库的名称

之后刷新仓库查看代码:

在这里插入图片描述

项目仓库地址: https://github.com/Chen0807AiLJX/next-blog

细心的大佬应该会发现我们这样提交代码是有问题的,因为我们并没有合并本地代码到本地仓库,所以提交到Github仓库的代码并不是我们最终的效果,而是创建Next.js时的初始效果。

不过不用担心,我们在后面会对其进行处理。当然,你也可以现在处理,直接将最新的代码同步到仓库,这样你就免了后面我们对其处理的操作

打开Vercel,没有Vercel账号的点击右上角的注册按钮进行注册,注册时选择通过Github注册,登录时也使用Github登录

登录Vecel成功后打开 https://vercel.com/import/githttps://vercel.com/new或点击新建项目按钮,之后进入到以下页面:

在这里插入图片描述
这个页面中会自动获取你的Github仓库,选择你刚刚推送博客项目的仓库,点击Import按钮,之后直接点击Deploy按钮:

在这里插入图片描述

稍等片刻,出现以下页面就部署成功了:

在这里插入图片描述

点击上述页面左侧的页面预览框就能跳转到你部署成功的网页了,但这时你会发现部署的页面不是我们最终的页面,而是创建Next.js时的初始页面,这是因为我们在Git提交代码到仓库时没有合并本地代码,我们重新提交一下就行了

我们可以在VScode里快速提交代码到仓库:

在这里插入图片描述
在这里插入图片描述

点击同步更改后会开始转圈,等待转圈结束就提交成功了,之后什么都不用干,仓库代码更新后Vercel会自动部署!!!

打开https://vercel.com/dashboard能查看到你已经部署的项目和对应的网页地址:

在这里插入图片描述

好啦,到此我们的任务就全部完成了,之后需要添加文章只需要在项目的posts文件内新建markdown文件就行了(不要忘记在markdown顶部添加元数据),更新完文章提交代码到仓库即可

结语

这次使用Next.js搭建个人博客只是一个小小的尝试,可以说是只搭建了一个骨架,其实走完整个流程你应该会有很多有趣的想法去完善填充你的博客,因为基础功能我们已经实现,剩下的就是锦上添花的操作了,这完全取决于你

项目仓库地址:https://github.com/Chen0807AiLJX/next-blog
最终效果可见:https://next-blog-eosin-six.vercel.app/

参考资料:

如果本篇文章对你有所帮助,还请客官一件四连!❤️

相关文章
|
11天前
|
存储 JavaScript 前端开发
使用Vue.js构建交互式用户界面的技术探索
【8月更文挑战第9天】Vue.js以其简洁的API、高效的性能、灵活的架构和强大的组件系统,成为了构建现代Web应用交互式用户界面的理想选择。通过掌握Vue.js的核心概念和最佳实践,开发者可以轻松地构建出既美观又实用的Web应用。随着Vue.js生态的不断发展和完善,相信它将在未来继续引领前端开发的潮流
|
11天前
|
前端开发 JavaScript 测试技术
构建与部署全栈JavaScript应用:从构思到上线的完整指南
【8月更文挑战第9天】构建和部署一个全栈JavaScript应用是一个复杂但充满挑战的过程。从需求分析到项目上线,每一步都需要精心策划和严格执行。通过本文的指南,希望能帮助你更好地理解和掌握全栈JavaScript应用的开发流程,从而打造出高性能、高可用、易维护的应用。
|
18天前
|
存储 缓存 JavaScript
构建高效后端服务:Node.js与Express框架的实战应用
【8月更文挑战第2天】在数字化时代的浪潮中,后端服务的构建成为了软件开发的核心。本文将深入探讨如何利用Node.js和Express框架搭建一个高效、可扩展的后端服务。我们将通过实际代码示例,展示从零开始创建一个RESTful API的全过程,包括路由设置、中间件使用以及数据库连接等关键步骤。此外,文章还将触及性能优化和安全性考量,旨在为读者提供一套完整的后端开发解决方案。让我们一同走进Node.js和Express的世界,探索它们如何助力现代Web应用的开发。
|
16天前
|
JavaScript 前端开发 API
如何使用Next.js构建应用
【8月更文挑战第4天】如何使用Next.js构建应用
38 2
|
16天前
|
弹性计算 JavaScript 中间件
构建高效后端服务:使用Node.js和Express框架
【8月更文挑战第4天】本文将通过一个实际案例,详细介绍如何使用Node.js和Express框架快速构建一个高效、可扩展的后端服务。我们将从项目初始化开始,逐步实现RESTful API接口,并介绍如何利用中间件优化请求处理流程。最后,我们将展示如何部署应用到云服务器上,确保其高可用性和可扩展性。
|
19天前
|
JavaScript 前端开发 中间件
构建高效后端服务:Node.js与Express框架的深度探索
【7月更文挑战第31天】在快速迭代的技术浪潮中,Node.js和Express框架已成为构建灵活、高效后端服务的利器。本文将深入探讨如何利用这一组合打造高性能后端系统,同时分享实际开发中的经验和技巧。
19 0
|
2月前
|
JSON JavaScript 中间件
Express.js:构建轻量级Node.js应用的基石
**Express.js 概览**:作为Node.js首选Web框架,Express以其轻量、灵活和强大的特性深受喜爱。自2009年以来,其简洁设计和丰富中间件支持引领开发者构建定制化应用。快速开始:使用`express-generator`创建项目,安装依赖,启动应用。示例展示如何添加返回JSON消息的GET路由。Express适用于RESTful API、实时应用等多种场景,社区支持广泛,助力高效开发。
35 1
|
2月前
|
缓存 JavaScript 前端开发
Vue.js框架在构建单页面应用中的最佳实践
Vue.js最佳实践包括组件化(如单一职责组件)、使用Vuex管理状态、axios处理异步请求、Vue Router进行路由、优化性能(keep-alive及懒加载)和选择UI库配合模块化样式。通过这些方法,开发者能构建高效、可维护的SPA。【6月更文挑战第25天】
38 1
|
1月前
|
JavaScript Shell 应用服务中间件
阿里云云效操作报错合集之Node.js构建报错,该如何排查问题
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。
|
1月前
|
JavaScript IDE 持续交付
阿里云云效产品使用合集之如何配置 Node.js构建任务让其在Windows环境中进行
云效作为一款全面覆盖研发全生命周期管理的云端效能平台,致力于帮助企业实现高效协同、敏捷研发和持续交付。本合集收集整理了用户在使用云效过程中遇到的常见问题,问题涉及项目创建与管理、需求规划与迭代、代码托管与版本控制、自动化测试、持续集成与发布等方面。

热门文章

最新文章