百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

用 VitePress 搭建电子书,绝了!(vitepress快速上手中文教程)

myzbx 2025-03-26 14:23 64 浏览

大家好,我是杨成功。

自从《前端开发实战派》出版以后,好多买过的小伙伴都联系我,问我有没有电子书?纸质书在公司看不方便,一些现成的代码没办法复制。

确实没有电子版,我也听大家的建议上微信读书,结果那边审核没通过。我想不行我自己搞一个电子书呗,给买了纸书的朋友免费阅读,方便他们随时查阅。

经过一番调研,VitePress 的 UI 我最喜欢,扩展性也非常好,所以就用它来搭建。

新建项目

在一个空文件夹下,使用命令生成项目:

sh
复制代码$ npx vitepress init

全部使用默认选项,生成结构如下:

图中的 .vitepress/config.mts 就是 VitePress 的配置文件。另外三个 .md 文件是 Markdown 内容,VitePress 会根据文件名自动生成路由,并将文件内容转换为 HTML 页面。

为了代码更优雅,一般会把 Markdown 文件放在 docs 目录下。只需要添加一个配置:

js复制代码// config.mts
export default defineConfig({
  srcDir: 'docs',
});

改造后的目录结构是这样:

安装依赖并运行项目:

sh复制代码$ yarn add vitepress vue
$ yarn run docs:dev

前期设计的难点

电子书的内容不完全对外开放,只有买过纸书的人才能阅读。和掘金小册差不多,只能看部分内容,登录或购买后才能解锁全部章节。

而 VitePress 是一个静态站点生成器,默认只解析 Markdown。要想实现上述的功能,必须用到纯 Vue 组件,这需要通过扩展默认主题来实现。

扩展默认主题,也就是扩展 VitePress 的原始 Vue 组件,达到自定义的效果。

遵循这个思路,我们需要扩展的内容如下:

  • 添加登录页面,允许用户登录。
  • 添加用户中心页面,展示用户信息、退出登录。
  • 修改头部组件,展示登录入口。
  • 页面根组件,获取当前用户状态。
  • 修改内容组件,无权限时不展示内容。

当然了还需要接入几个接口:

  • 登录/注册接口。
  • 获取当前用户信息接口。
  • 验证当前用户权限的接口。

扩展默认主题

扩展默认主题,首先要创建一个 .vitepress/theme 文件夹,用来存放主题的组件、样式等代码。该文件夹下新建 index.ts 表示主题入口文件。

入口文件导出主题配置:

js复制代码// index.ts
import Layout from './Layout.vue';

export default {
  Layout,
  enhanceApp({ app, router, siteData }) {
    // ...
  },
};

上面代码导入了一个 Layout.vue,这个组件是自定义布局组件:

vue复制代码
<script setup>
import DefaultTheme from 'vitepress/theme';

const { Layout } = DefaultTheme;
</script>

为啥需要这个组件呢?因为该组件是项目根组件,可以从两个方面扩展:

(1)使用自定义插槽。

Layout 组件提供了许多插槽,允许我们在页面的多处位置插入内容。比如上面代码中的 nav-bar-content-after 插槽,会在头部组件右侧插入登录按钮。

具体有哪些插槽,详见这里。

(2)做全局初始化。

当刷新页面时,需要做一些初始化操作,比如调用接口、监听某些状态等。

这个时候可以使用 Vue 的各种钩子函数,比如 onMounted:

js复制代码// Layout.vue
<script setup>
import { onMounted } from 'vue';
onMounted(() => {
  console.log('初始化、请求接口');
});
</script>

如何定制内容组件?

VitePress 的内容组件,会把所有 Markdown 内容渲染出来。但是如果用户没有登录,我们不允许展示内容,而是提示用户登录,就像掘金小册这样:

定制内容组件,核心是在内容渲染的区域加一个判断:如果用户登录且验证通过,渲染内容即可;否则,展示类似上图的提示登录界面。

接下来我翻了 VitePress 的源码,找到了这个名为 VPDoc.vue 的组件:

github.com/vuejs/vitep…

在上方组件大概 46 行,我找到了内容渲染区域:

就在这个位置,添加一个判断,就达到我们想要的效果了:

js复制代码

登录后阅读全文

那怎么让这个修改生效呢?

VitePress 提供了一个 重写内部组件 的方案。将 VPDoc.vue 组件拷贝到本地,按照上述方法修改,重命名为 CusVPDoc.vue

在配置文件 .vitepress/config.ts 中添加重写逻辑:

js复制代码// config.ts
export default defineConfig({
  vite: {
    resolve: {
      alias: [
        {
          find: /^.*\/VPDoc\.vue$/,
          replacement: fileURLToPath(new URL('./components/CusVPDoc.vue', import.meta.url)),
        },
      ],
    },
  },
});

这样便实现了自定义内容组件,电子书截图如下:

添加自定义页面

添加自定义页面,首先要创建一个自定义组件。

以登录页面为例,创建一个自定义组件 CusLogin.vue,编写登录页面和逻辑,然后将其注册为一个全局组件。在 Markdown 页面文件中,直接使用这个组件。

注册全局组件的方法,是在主题入口文件中添加以下配置:

js复制代码// .vitepress/theme/index.ts
import CusLogin from './components/CusLogin.vue'

export default {
  ...
  enhanceApp({ app}) {
    app.component("CusLogin", CusLogin); // 注册全局组件
    // ...
  },
} satisfies Theme;

最后,新建 Markdown 文件 login.md,写入内容如下:

md复制代码---
layout: page
---

现在访问路由 “/login” 就可以看到自定义登录页面了。

全局状态管理

涉及到用户登录,那么必然会涉及在多个组件中共享登录信息。

如果要做完全的状态管理,不用说,安装 Pinia 并经过一系列配置,可以实现。但是我们的需求只是共享登录信息,完全没必要再装一套 Pinia,使用 组合式函数 就可以了。

具体怎么实现,在另一篇文章 Vue3 新项目,没必要再用 Pinia 了! 中有详细介绍。

接入 Bootstrap

自定义页面,总是需要一个 UI 框架。上面的登录页面中,我使用了 Bootstrap。

Vitepress 使用 UI 框架有一个限制:必须兼容 SSR。因为 Vitepress 本质上使用了 Vue 的服务端渲染功能,在构建期间生成多个 HTML 页面,并不是常见的单页面应用。

这意味着,Vue 组件只有在 beforeMountmounted 钩子中才能访问 DOM API。

而 Bootstrap 不需要打包构建就可以使用 UI,非常适合 Vitepress。

首先安装 Bootstrap:

sh
复制代码$ yarn add bootstrap

然后在主题入口文件中引入 Sass 和 JS 文件:

js复制代码import 'bootstrap/scss/bootstrap-cus.scss';
import 'bootstrap/dist/js/bootstrap.bundle.min.js';

按常理说,这样就可以了,但是实际运行会报错:找不到某个 DOM API。

还记得那个限制吗?必须兼容 SSR!因此不能直接引入 JS 文件。

解决方法是在自定义布局组件 Layout.vue 中通过异步的方式引入:

js复制代码// .vitepress/theme/Layout.vue
onMounted(() => {
  import('bootstrap/dist/js/bootstrap.bundle.min.js');
});

这样就大功告成了,你可以使用 Bootstrap 中丰富的 UI。

最终的电子书效果:《前端开发实战派》,欢迎点评。

作者:杨成功 链接:
https://juejin.cn/post/7355759709167910923

相关推荐

零基础入门AI智能体:详细了解什么是变量类型、JSON结构、Markdown格式

当品牌跳出固有框架,以跨界联动、场景创新叩击年轻群体的兴趣点,一场关于如何在迭代中保持鲜活的探索正在展开,既藏着破圈的巧思,也映照着与新一代对话的密码。在创建AI智能体时,我们会调用插件或大模型,而在...

C# 13模式匹配:递归模式与属性模式在真实代码中的性能影响分析

C#13对模式匹配的增强让复杂数据处理代码更简洁,但递归模式与属性模式的性能差异一直是开发者关注的焦点。在实际项目中,选择合适的模式不仅影响代码可读性,还可能导致执行效率的显著差异。本文结合真实测试...

零基础快速入门 VBA 系列 6 —— 常用对象(工作簿、工作表和区域)

上一节,我介绍了VBA内置函数以及如何自动打字和自动保存文件。这一节,我们来了解一下Excel常用对象。Excel常用对象Excel有很多对象,其中最常用也最重要的包括以下3个:1.Workbo...

不同生命数字的生肖龙!准到雷普!

属龙的人总在自信爆棚和自讨苦吃之间反复横跳?看完这届龙宝宝的日常我悟了。属龙的人好像天生自带矛盾体:领导力超强可人缘时好时坏,工作雷厉风行却总在爱情里翻车。关键年份的龙性格差异更大——76年龙靠谱但不...

仓颉编程语言基础-面向对象编程-属性(Properties)

属性是仓颉颉中一种强大的机制,它允许你封装对类(或接口interface、结构体struct、枚举enum、扩展extend)内部状态的访问。它看起来像一个普通的成员变量(字段),但在其背后,它通过...

Python中class对象/属性/方法/继承/多态/魔法方法详解

一、基础入门:认识类和对象1.类和对象的概念在Python中,类(class)是一种抽象的概念,用于定义对象的属性和行为,而对象(也称为实例)则是类的具体表现。比如,“汽车”可以是一个类,它有...

VBA基础入门:搞清楚对象、属性和方法就成功了一半

如果你刚接触VBA(VisualBasicforApplications),可能会被“对象”“属性”“方法”这些术语搞得一头雾水。但事实上,这三个概念是VBA编程的基石。只要理解它们之间的关系,...

P.O类型文推荐|年度编推合集(一百九十五篇)

点击左上方关注获取更多精彩推文目录2019年度编推35篇(1V1)《悖论》作者:流苏.txt(1V1)《桂花蒸》作者:大姑娘浪.txt(1V1)《豪门浪女》作者:奚行.txt...

Python参数传递内存大揭秘:可变对象 vs 不可变对象

90%的Python程序员不知道,函数参数传递中可变对象的修改竟会导致意想不到的副作用!一、参数传递的本质:对象引用传递在Python中,所有参数传递都是对象引用的传递。这意味着函数调用时传递的不是对...

JS 开发者必看!TC39 2025 最新动向,这些新语法要火?

大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发,您的支持是我不断创作的动力。TC39第...

2025 年值得尝试的 5 个被低估的 JavaScript 库

这些JavaScript库可能不会在社交媒体或HackerNews上流行起来,但它们会显著提高您的工作效率和代码质量。JavaScript不再只是框架。虽然React、Vue和Sv...

Python自动化办公应用学习笔记30—函数的参数

一、函数的参数1.形参:o定义:在函数定义时,声明在函数名后面括号中的变量。o作用:它们是函数内部的占位符变量,用于接收函数被调用时传入的实际值。o生命周期:在函数被调用时创建,在函数执...

16种MBTI人格全解析|测完我沉默了三秒:原来我是这样的人?

MBTI性格测试火了这么久,你还不知道自己是哪一型?有人拿它当社交话题,有人拿它分析老板性格,还有人干脆当成择偶参考表。不废话,今天我一次性给你整理全部16种MBTI人格类型!看完你不仅能知道自己是谁...

JS基础与高级应用: 性能优化

在现代Web开发中,性能优化已成为前端工程师必须掌握的核心技能之一。本文从URL输入到页面加载完成的全过程出发,深入分析了HTTP协议的演进、域名解析、代码层面性能优化以及编译与渲染的最佳实践。通过节...

爱思创CSP-J/S初赛模拟赛线上开赛!助力冲入2024年CSP-J/S复赛!

CSP-J/S组初赛模拟赛爱思创,专注信奥教育19年,2022年CSP-J/S组赛事指定考点,特邀NOIP教练,开启全真实CSP-J/S组线上初赛模拟大赛!一、比赛对象:2024年备考CSP-J/S初...