-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
文档复用中的多链接场景需求。 #4386
Comments
Very hard to follow here. Consider writing in English. |
You should use Vue Component here. |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
困惑
在多文档写作中经常会有重复的内容出现,我们希望做到一处改动,处处更新。这是技术文档写作中的文档复用。
在使用VitePress建设个人网站的时候关注到,文档复用的需求可以使用
包含markdown文件
功能实现。但有一个场景目前大部分静态文档网站均无法实现:就是当复用源中包含了连接跳转,而这些链接在不同的文档中又指向了不同的地址。为了描述方便,我们把这种场景称作多链接复用场景,被复用的文档称作复用源,引用内容的文档称作引用文档。
现状
我尝试使用VitePress提供的
包含markdown文件
、外部链接
和访问frontmatter数据
三个功能组合进行需求实现。但效果并不理想。在Markdown语法中,连接的写法是[title](link)
。当我尝试在link中使用Mustache语法时,VitePress并没有对其进行解析。如下图所示:Describe the solution you'd like
包含markdown文件
功能确实能非常好的实现复用功能,但希望能在此功能上有所突破。我试想了一种解决方案,形式跟Vue.js中的插槽很像。想象方案
[]
,用于对应占位符名字给变量赋值。代码形式如下:
如此让文档间的关系多了类似继承的特性,真正实现了docs like code。
Describe alternatives you've considered
目前的代替方案只能是将复用源文档进行分块复用,采用
块1
+link
+块2
的方式完成需求。但当文档中类似的情况多起来后,维护连接就变得异常困难。
而且有些为了提升阅读体验采用整篇复用的文档,也会因为这个小小的需求从整篇复用拆成分块复用,致使工作量飙升。
Additional context
No response
Validations
The text was updated successfully, but these errors were encountered: