VS-Code-Extension-Doc-ZH icon indicating copy to clipboard operation
VS-Code-Extension-Doc-ZH copied to clipboard

测试更换渲染方案为vuepress

Open Rackar opened this issue 4 years ago • 3 comments

docsify貌似没有生成静态页面,在路由跳转中经常会出现找不到内容和延迟加载渲染的问题。 试着fork的一份用我熟悉的vuepress静态化方式改了一点,基本能解决这个问题。

https://github.com/Rackar/VS-Code-Extension-Doc-ZH

但是fork的版本无法使用github action来自动部署页面。所以又单独开了项目: https://github.com/Rackar/vscode-ext-doccn

演示页面: https://rackar.github.io/vscode-ext-doccn/extensibility-reference/activation-events.html#activationevents-onlanguage

由于navbar和sidebar目前都是自动提取的,章节和导航比较乱。 如果这套方案可以接受的话,以后逐步改善一下然后pr回来。

Rackar avatar Mar 21 '20 04:03 Rackar

非常感谢你的建议,为了加快github访问速度,项目本身已经做了一些优化,但是为了更好的访问体验,项目也会在你的提案方向上进行探索,该提案目前已知的问题有

  1. 样式保留问题
  2. 导航优化问题
  3. 加速的有效性检验
  4. 迁移成本较高

如果你对这些问题有更多的见解,欢迎继续为该项目作出建议和改进🙋‍♂️

Liiked avatar Apr 07 '20 16:04 Liiked

@Liiked 感谢回复。

1.样式问题。 样式基本差别不大,如要调整代码框颜色等轻微差别,可定义全局CSS。 目前有一个 >? 重点提示标签现在无法渲染。 vuppress使用如下样式作为自定义容器,有4种关键词可做区分

:::waring
提示:xxxx
:::

image

2.导航 今天花了点时间将导航条与侧边栏修改完毕。

3.加速 静态结果已部署,可进行测试

4.迁移 还剩评论模块未迁移。vuepress可接入gitalk

https://rackar.github.io/vscode-ext-doccn

Rackar avatar Apr 08 '20 07:04 Rackar

已基本修改完毕,如果没什么意见可以提交pr了。 还剩最后一点小问题,使用git action脚本的话,分支名和token需要修改和配置一下,以及站点默认链接pr时需修改。

Rackar avatar Apr 09 '20 02:04 Rackar