前言
之前一直想写一套的基于 vue 的组件库,一直都没有找到快速构建规范化文档的工具,今天偶然看到了 vue 官方推出的 vuepress,可以用来快速生成文档的页面,并提供了与 vue 官方文档一致的默认主题
使用过程
安装
vuepress 提供了全局以及局部方式,我使用的是全局方式,并使用 yarn 作为 node 包管理工具
yarn global add vuepress
开发
进入任何你想在其中编写文档的文件夹里,创建一个 README.md 文件,按照 Markdown 语法随意写上一些内容,打开命令行,输入:
vuepress dev .
即可运行 vuepress 集成了 webpack-dev-server 的开发模式,访问 localhost:8080 即可看到刚刚创建的 README.md 文件,不过是以 vue 官方默认主题渲染而成的 html 页面
构建
vuepress build .
如果想修改主题里的某个部分
vuepress 提供了主题继承的方式
如果想自定义主题
vuepress 提供了主题开发
还可以开发自己的 vuepress 插件
感受
vuepress 提供了开箱即用的体验,上手非常简单,并且保留了所有的可配置性,自定义布局,主题,插件等,也支持部分覆盖原主题,当然也可以自定义拓展 webpack 的配置,还提供了在 markdown 文件里直接调用 vue 组件,以及 markdown 插槽这些非常方便的特性
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于