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

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

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

大家好,我是杨成功。

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

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

经过一番调研,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

相关推荐

怎么恢复7z文件 7z文件删除了怎么恢复

7z是一种压缩格式的文件,它运用LZMA压缩算法,该压缩算法的输出稍后被算数编码进行处理以便后续进一步压缩,压缩比十分高。我们可以将文件压缩成这种格式,便于传输,保存,占空间少。了解更多7z文件知识...

郎酒让消费者喝得明明白白 算术题里有答案

日前,『郎酒酱香产品企业内控准则』颁布,郎酒首次公开酱香产品生产全过程,公布酱香产品产能、储能及投放计划。随后,郎酒官微向消费者发出「品控算术题」有奖问答。郎酒亮出家底,消费者踊跃留言。8天后,谜底揭...

学龄前,比识字、算术更重要的是这三件事

“为了给孩子选择一家合适的幼儿园,我曾穿梭于纽约各家幼儿园的开放日,这些幼儿员既包括主流的公立幼儿园,还包括那些遥不可及的私人幼儿园。我的目的就是想了解他们的教育理念是什么,到底厉害在哪里,看看对于我...

参加CSP-J信奥赛需要掌握数学知识

在C++语法的学习中需要储备的数学知识如下①数据类型:需要知道整数、正整数、负整数、小数、判断对错②算术运算符:加法、减法、乘法、除法、取模运算③关系表达式:大于、大于等于、小于、小...

1g米饭能做多少深蹲?今天我们来算一算

减重我们都知道3分在练,7分在吃,吃这件事情上,真的是每一口都算数。今天我们来算一笔账,1粒米饭可以做多少事情?本着认真负责的态度,今天在食物秤上称了1g米饭,是16粒。根据能量换算:100g米饭是4...

web 自动化测试,一定得掌握的 8 个核心知识点

使用cypress进行端对端测试,和其他的一些框架有一个显著不同的地方,它使用JavaScript作为编程语言。传统主流的selenium框架是支持多语言的,大多数QA会的pytho...

大话C语言:赋值运算符(c语言中赋值运算符是什么)

赋值运算符是最基本的运算符之一,用于将右侧的值或表达式的计算结果赋给左侧的变量。它是一个二元运算符,意味着它需要两个操作数:一个是目标变量(左侧),另一个是要赋给该变量的值或表达式(右侧)。赋值运算符...

Vue进阶(幺幺伍):js 将字符串转换为boolean

Boolean();参数为0、null和无参数返回false,有参数返回true。Boolean("");//输出为:falseBoolean(null);//输出为...

mongodb查询的语法(大于,小于,大于或等于,小于或等于等等)

1).大于,小于,大于或等于,小于或等于$gt:大于$lt:小于$gte:大于或等于$lte:小于或等于例子:db.collection.find({"field":{$gt:valu...

Python学不会来打我(21)python表达式知识点汇总

在Python中,表达式是由变量、运算符、函数调用等组合而成的语句,用于产生值或执行特定操作。以下是对Python中常见表达式的详细讲解:1.1算术表达式涉及数学运算的表达式。例如:a=5b...

C|数据存储地址与字节偏移、数据索引

话说C是面向内存的编程语言。数据要能存得进去,取得出来,且要考虑效率。不管是顺序存储还是链式存储,其寻址方式总是很重要。顺序存储是连续存储。同质结构的数组通过其索引表示位置偏移,异质结构的结构体通过其...

下班后累懵?4 个 JS 手写题帮你搞定前端面试高频考点

打工人下班后最痛苦的事,莫过于拖着疲惫的身子还要啃前端面试题吧?看着那些密密麻麻的JS代码,脑子都快转不动了!别担心,今天咱就用轻松的方式,带你吃透4道高频手写题,让你在面试时自信满满,再也不...

嵌入式数据库sqlite3【进阶篇】-子句和函数的使用,小白一文入门

sqlite在《嵌入式数据库sqlite3命令操作基础篇-增删改查,小白一文入门》一文中讲解了如何实现sqlite3的基本操作增删改查,本文介绍一些其他复杂一点的操作。比如where、orderby...

前缀表达式与后缀表达式(前缀表达式后缀表达式中缀表达式计算)

昨天晚上和儿子一起学习了前缀表达式和后缀表达式。这应该是字符串算式如何被计算机识别并计算的2种方法。本来是想先给他讲一个逆波兰式(后缀表达式),以后再讲前缀表达式。没想到他还挺聪明,很快就把2个都掌握...

Python快速入门教程1:基本语法、数据类型、运算符、数字字符串

Python3的基础教程,涵盖了基本语法、数据类型、类型转换、解释器、注释、运算符、数字和字符串等内容,并附有使用实例场景。Python3的基础教程,涵盖了基本语法、数据类型、类型转换、解释器、注释、...