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

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

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

大家好,我是杨成功。

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

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

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

相关推荐

06Ni9DR容器板,06Ni9DR钢板切割,06Ni9DR钢板规格尺寸

06Ni9DR容器板,06Ni9DR钢板切割,06Ni9DR钢板规格尺寸06Ni9DR是低温容器钢板,含有9%Ni的钢板,06Ni9DR因为钢板Ni含量在百分之0.9左右又被叫作9镍钢或9Ni钢,06...

TOS5系统命令行部署Docker版网心云

  Docker版网心云也就官主叫做容器魔方,由网心云推出的一款docker容器镜像软件,目前支持:铁威马TOS、koolshare、群晖、树莓派等支持docker的设备(arm32、aarch64、...

诞生比航母还早,能造的国家屈指可数

蒸汽弹射器是航空母舰上的飞机起飞装置,用于舰载机蒸汽弹射起飞,使用一个平的甲板作为飞机跑道。起飞时一个蒸汽驱动的弹射装置带动飞机在两秒钟内达到起飞速度。蒸气弹射器是一个非常复杂的系统工程,是由起飞系统...

S550QL high strength steel plate、S550QL相当于国内什么材质

S550QLhighstrengthsteelplate、S550QL相当于国内什么材质S550QLhighstrengthsteelplate调质高屈服强度结构钢。S550QL相当于...

特别关注|中垂变形对VLCC油轮载货量的影响

VLCC油轮营运过程中,在船抵达装运港之前,船长需要计算和申报本航次的最大装货量,影响货物最大装货量的各相关因素主要有:●该轮在装货港所允许的最大吃水;●货舱舱容和油品密度;●VLCC航线通常...

南海车改装音响奥迪S5升级弗莱德FP-6A功放—永日汽车音响

奥迪S5的原车音响效果也比较普通的,其实跟其他日产国产车好不了多少,整体表现含糊不清;所以很难满足今天来的奥迪车主聆听需求,为了享受到更好的音乐,为爱车进行音响升级。奥迪S5音响升级配置:前声场:弗莱...

奥迪S5轿跑:354马力+3.0T奥迪进口车,落地近70万,选它还是A7?

前几天我们介绍了奥迪S5,今天我们拿到的是奥迪的S5,可谓是A5的性能版本,往上还有RS5,S5落地近70万,和4缸的奥迪A7同一价位,相当于2台进口A5低配的价格,而这个价位,可供选择的余地太多了...

S5定时器与IEC定时器差异巨大,资料分散难入门,你真的懂了吗?

你有没有想过,小小的定时器,在工业自动化里竟然扮演着如此重要的角色?它就像一位精准的指挥家,掌控着生产线的节奏。今天,我们就来聊聊PLC编程里两种常见的定时器:S5定时器和IEC定时器。它们看起来差不...

LOL英雄联盟S5新赛季季前赛野区入门手册

本文摘要:随着S5季前赛的到来,LOL各个方面都做了不小的改动,而其中改动最明显的莫过于野区,现在从各方面来带大家认识一下改版后的野区。首先是野怪的伤害有了非常大的提升并且惩戒的CD时间被提高到了一分...

六个重点 搞懂全新Audi A5 Coupe改在哪

由于Audi正式进入新一世代后的车款各个都有著令人印象深刻的亮眼表现,品牌旗下的双门轿跑车系A5Coupe的改款同样让人期待不已,也就在2016年6月3日,全新一代AudiA5以及S5终于正式的与...

入门级视频拍摄设备该如何选?(拍视频设备推荐性价比)

如今的年轻人都很热衷于视频制作,B站各种领域的up主层出不穷,而短视频领域,大家也开始倾向于使用专业的设备去拍摄。对于很多想要开启自己视频拍摄生涯的小伙伴来说,如何选择一台入门级的视频拍摄设备很关键,...

pb管规格及用途这么多,你知道多少?

导语:谈到PB管,估计大家都只知其一不知其二,pb管在生活中到底扮演着什么样的角色呢?它给我们的生活带来了那些便利呢?下面让小编带领大家来一块了解pb管的奥秘!pb管的材料是聚丁烯(PB)树脂,开始工...

Bcup S5今日开赛,Life又复出了(b05赛制)

由知名电竞解说BBC(直播间抖音搜索:BBC张宏圣)主办的Bcup魔兽争霸赛S5将于2024年1月3日20点正式开战。目前,S5分组已经全部出炉,下面让我们一起看下。S5最大的亮点莫过于前职业选手Li...

无主之地2:仍然可用的SHiFT代码(2023年1月15日)

兑换方式需要首先注册SHiFT账号,可以在SHiFT网站注册,也可以在游戏中注册。SHiFT网址:https://shift.gearboxsoftware.com游戏中注册:主菜单>...

三年LOL资深玩家,教你在S5玩转VN

做为一个资深的LOL玩家,我已经玩了有几年了,从12年那会就已经开始玩了。在LOL当中我最喜欢的adc就是薇恩没有之一。每次玩LOL,最后一盘必定是薇恩。在这说说个人玩VN的经验跟大家一起分享下,不认...