使用vuepress写组件文档的问题最近在用vuepress写组件的文档。在展示用例的时候,我总是想同时展示源代码。但是导入代码片段<<<@/filepath的语法写起来有点麻烦,因为一般你的示例代码都放在docs/.vuepress/components路径下,导致你要导入就得写组件代码长路。而且,如果你的示例代码很多,几百行,会显得你的页面很长,体验也不是很好。如果代码能像某些组件库的官网一样,可以点击查看然后收起来,体验会非常好。没有现成的插件?在写这个插件之前,我找过相关的插件,但是发现它们都有一个缺点。就是把代码写在markdown文件里,这样就不会得到代码提示之类的。于是写了一个vuepress插件vuepress-plugin-code-example,使用起来非常简单。你只需要给出文件相对于docs/.vuepress/components路径的地址。:::code-examplepath-to-file:::比如你的组件路径是docs/.vuepress/components/demo.vue:::code-exampledemo.vue:::也可以查看效果预览在我的组件库文件erpack在线体验效果。有一个小亮点。总是有很长的示例代码。当你展开它时,如果你想把它收起来,你必须向上滚动几次。所以我给了一个按钮交互。在查看某个例子时,按键盘上的ESC键可以切换显示和隐藏源代码。(需要先点击这个示例块)欢迎吐槽丑陋的风格。
