VuePress 博客优化之中文锚点跳转问题

简介: 「这是我参与2022首次更文挑战的第7天,活动详情查看:2022首次更文挑战」。

0.png


「这是我参与2022首次更文挑战的第7天,活动详情查看:2022首次更文挑战」。


前言


《一篇带你用 VuePress + Github Pages 搭建博客》中,我们使用 VuePress 搭建了一个博客,最终的效果查看:TypeScript 中文文档


VuePress 会在每个标题左侧都加一个锚点链接:


1.png


点击后链接变为:


http://ts.yayujs.com/learn-typescript/handbook/TheBasics.html#降级-downleveling
复制代码


此时刷新下页面,会发现,页面并不能正确的定位到锚点位置,而且打开开发者工具,还会看到报错:


2.png


那这个问题该怎么解决呢?


错误定位


在线上由于代码都是压缩混淆后的,不好排查,我们在本地运行项目,然后查看报错信息:


3.png


可以看到错误是来自于 vuerepss-plugin-smooth-scroll 这个插件中,我们点击查看具体的源码:


4.png


可以看到,报错是来自于 document.querySelector(to.hash) 这句,为什么会在这里报错呢?


这是因为对于每一个标题,VuePress 都会生成这样一个 DOM 结构:


5.png


可以看到h2标签的id是以 hash 值命名的,如果我们的 hash 是纯英文,并没有什么问题,但是现在我们的 hash 中有中文,由于中文被编码,document.querySelector报错。


官方方案


这个问题这么容易复现,且这么明显,我想肯定有人提了 issue,查看 VuePress 的 issue,可以看到在 2020 年  10 月 3 号就有人提了 PR,并且 merge 了。


那为什么还会报错呢?


如果我们去掉我们目前在用的 reco主题,我们就会发现,页面并不会有报错,只不过依然不能定位到锚点而已。


实际上,我们的报错是来自于我们使用的 reco 主题使用的 vuerepss-plugin-smooth-scroll 插件。


社区方案


那成吧,那搜索看下其他人是否也遇到过这个问题吧,可以查到这样一个方案


新建一个 docs/.vuepress/theme/layouts/Layout.vue文件,代码写入:


<script>
export default {
  methods: {
    scrollTo(selector) {
      if (!selector || selector === '#') return
      const el = document.querySelector(decodeURIComponent(selector))
      if (el && el.offsetTop) {
        window.scrollTo(0, el.offsetTop)
      }
    }
  },
  mounted() {
    this.scrollTo(location.hash)
  }
}
</script>
复制代码


使用后,页面是不报错了,但会发现样式全部丢失了,因为使用这种方式相当于新建了一个主题,vuePress 已经改用我们的自定义主题了。


不过 VuePress 提供了主题继承的功能,新建一个 docs/.vuepress/theme/index.js,代码写入:


module.exports = {
  extend: '@vuepress/theme-default'
}
复制代码


样式是恢复了一些,但是因为我们本来使用的是 reco 主题,现在改成了继承 vuepress 默认主题,reco 主题带来的一些功能就全丢失了,那我们能继承 reco 主题吗?


答案是不能,这在 VuePress 官方文档的「主题的继承 」章节里有讲到:


主题继承暂时不支持高阶继承,也就是说,一个派生主题无法被继承。


所以为了解决这个方案,就要放弃 reco 主题,而放弃了  reco 主题,本来也不会有报错了……


那我们换个方案吧。


自己动手


成吧成吧,我自己解决。


梳理下当下的问题,当访问带中文锚点的链接时:


  1. 页面有报错,而报错来自于 reco主题使用的 vuepress-plugin-smooth-scroll主题。
  2. 不能正常跳转到锚点位置


页面报错这个问题最简单粗暴的方式就是修改源码了,我们打开 node_modules/vuepress-plugin-smooth-scroll/lib/enhanceApp.js,直接修改:


const enhanceApp = ({ Vue, router }) => {
    router.options.scrollBehavior = (to, from, savedPosition) => {
        // ...
        else if (to.hash) {
            //...
            // 加上 decodeURIComponent
            const targetElement = document.querySelector(decodeURIComponent(to.hash));
            //...
        }
        // ...
    };
};
复制代码


因为我们并不会提交源码,而是提交编译后的文件到服务器上,所以改了依赖的源码也没有什么影响。


接下来是页面加载完跳转到锚点位置,之前我们在 《VuePress 博客优化之添加数据统计功能》,在 enhanceApp.js 中监听路由的改变,同样我们可以监听路由的 ready 事件,然后跳转到直接的位置,我们修改下 .vuepress/enhanceApp.js中的代码:


export default ({ router }) => {
  // ...
  router.onReady(() => {
    const { hash } = document.location;
    setTimeout(() => {
      if (hash.length > 1) {
        const id = decodeURIComponent(hash);
        const el = document.querySelector(`.reco-side-${decodeURIComponent(id).substring(1)}`);
        el.click();
      }
    }, 1000);
  });
};
复制代码


在这里并没有直接获取标题 DOM 元素的位置,然后使用 window.scrollTo 跳转,这是因为在 reco 主题下,随着用户不断的浏览,其实路由也在不停的切换,右侧的目录才会随之改变,这里直接模拟了右侧目录的点击操作,也是为了将具体跳转的行为交给 reco 来实现。


系列文章


博客搭建系列是我至今写的唯一一个偏实战的系列教程,预计 20 篇左右,讲解如何使用 VuePress 搭建、优化博客,并部署到 GitHub、Gitee、私有服务器等平台。本篇为第 20 篇,全系列文章地址:github.com/mqyqingfeng…


微信:「mqyqingfeng」,加我进冴羽唯一的读者群。


如果有错误或者不严谨的地方,请务必给予指正,十分感谢。如果喜欢或者有所启发,欢迎 star,对作者也是一种鼓励。



目录
相关文章
|
3月前
EMLOG程序单页友链和标签增加美化
EMLOG程序单页友链和标签增加美化
44 3
EMLOG程序单页友链和标签增加美化
文本,vitepress代码风格配置和序号配置,第几行到第几行出现高亮显示,最上方图标出现 ,网页排序出现博客,vitepress如何默认折叠效果
文本,vitepress代码风格配置和序号配置,第几行到第几行出现高亮显示,最上方图标出现 ,网页排序出现博客,vitepress如何默认折叠效果
文本,Vitepress的优势之处,配合Typora进行页面撰写可以同步设计相同的HTML页面
文本,Vitepress的优势之处,配合Typora进行页面撰写可以同步设计相同的HTML页面
|
前端开发
掘金Markdown编辑器中的图片怎么居中?
掘金Markdown编辑器中的图片怎么居中?
499 0
uniapp设置tabBar跳转后,其他页面跳转到主页、主页参数、接参(整理)
uniapp设置tabBar跳转后,其他页面跳转到主页、主页参数、接参(整理)
|
Web App开发 JavaScript API
怎么从零编写一个 v3 版本的 chrome 浏览器插件实现 CSDN 博客网站的暗黑和明亮主题切换?
怎么从零编写一个 v3 版本的 chrome 浏览器插件实现 CSDN 博客网站的暗黑和明亮主题切换?
858 0
怎么从零编写一个 v3 版本的 chrome 浏览器插件实现 CSDN 博客网站的暗黑和明亮主题切换?
Hugo 网站优化(1): 渲染 Markdown 图片引用地址
搭建一个自己的博客系统, 优化图片展示, 让书写更简单
480 0
Hugo 网站优化(1): 渲染 Markdown 图片引用地址
|
移动开发 前端开发 HTML5
web前端学习(四)——HTML5的超链接标签设置(页面间链接、锚链接以及邮件链接)
web前端学习(四)——HTML5的超链接标签设置(页面间链接、锚链接以及邮件链接)
web前端学习(四)——HTML5的超链接标签设置(页面间链接、锚链接以及邮件链接)
|
搜索推荐 JavaScript 算法
VuePress 博客之 SEO 优化(三)标题、链接优化
本篇讲讲 SEO 中的一些细节优化。
410 0
VuePress 博客之 SEO 优化(三)标题、链接优化
|
前端开发 JavaScript 容器
CSS 自动显示“全文”链接
CSS 自动显示“全文”链接
CSS 自动显示“全文”链接