摘要：实现使用编写的个人组件库说明文档前一篇文章实现了按需加载封装个人的组件库功能，有了组件库，当然还要有配套说明文档，这样使者用起来才更方便。特别说明本文中有部分实现是了的代码实现的。
实现使用markdown编写的个人组件库说明文档
前一篇文章实现了按需加载封装个人的组件库功能，有了组件库，当然还要有配套说明文档，这样使者用起来才更方便。打包完成的dist目录是最终可放到服务器中，直接访问到文档的哟。
项目github地址：https://github.com/yuanalina/installAsRequired
在项目中配置打包examples
上篇文章中，执行打包命令会将项目打包至lib下，打包完成的目录结构是适合直接发布为npm包，使用时使用import等引入的。其中并没有html文件入口，所以要有说明文档，直接在浏览器中可访问，还需要重新配置打包。
打包examples相关目录结构及webpack配置
一、package.json增加打包命令"build_example": "node build/build.js examples"
二、在src同级增加examples目录，存放文档相关文件
examples目录中：1、assets目录存放静态资源依赖，2、components存放vue组件，3、docs目录存放.md文件，说明文档，4、main.js会作为打包的入口，在这里引入项目的组件、第三方依赖：element-ui、路由配置等，5、route.js路由配置，6、index.html作为打包的html模版，7、App.vue
三、webpack相关配置
在build目录中增加webpack.prod.examples.conf.js文件，配置打包example。这个文件是vue-cli生成项目中的webpack.prod.conf.js稍作修改，改动部分：
1、增加output出口配置，由于之前在config中将这个值设置成了../lib，这里把值设置为../dist，将examples打包后输出到dist
2、设置打包入口为examples下的main.js
3、设置html模版为./examples/index.html
另外在build/build.js中，需要判断example参数，更改一下output出口路径，如图：
技术实现
编写说明文档，最直观的还是使用markdown编写，看了elementUI的实现方案，决定按elementUI的技术方案去实现。特别说明：本文中有部分实现是copy了elementUI的代码实现的。后面会特别指出
相关依赖安装
npm i highlight -D //安装语法高亮
npm i markdown-it markdown-it-anchor markdown-it-container -D // 安装markdown相关依赖
npm i vue-markdown-loader -D //安装vue-markdown-loader，解析.md文件为.vue文件
webpack相关配置
安装了vue-markdown-loader解析.md文件，在webpack.base.conf.js文件中，需要进行相关的loader配置，这里的配置相关，都是copy的element-ui中的代码。改动部分如下：
一、首先增加strip-tags文件到/build目录中，strip-tags内容如下：
/*!
* strip-tags
*
* Copyright (c) 2015 Jon Schlinkert, contributors.
* Licensed under the MIT license.
*/
"use strict";
var cheerio = require("cheerio");
exports.strip = function(str, tags) {
var $ = cheerio.load(str, {decodeEntities: false});
if (!tags || tags.length === 0) {
return str;
}
tags = !Array.isArray(tags) ? [tags] : tags;
var len = tags.length;
while (len--) {
$(tags[len]).remove();
}
return $.html();
};
exports.fetch = function(str, tag) {
var $ = cheerio.load(str, {decodeEntities: false});
if (!tag) return str;
return $(tag).html();
};
二、webpack.base.conf.js的改动
1、增加引入strip-tags和markdown-it
const striptags = require("./strip-tags")
const md = require("markdown-it")()
2、增加工具函数
const wrap = function(render) {
return function() {
return render.apply(this, arguments)
.replace("", "")
}
}
function convert(str) {
str = str.replace(/(&#x)(w{4});/gi, function($0) {
return String.fromCharCode(parseInt(encodeURIComponent($0).replace(/(%26%23x)(w{4})(%3B)/g, "$2"), 16))
})
return str
}
3、增加.md相关loader配置,将.md文件解析为.vue文件，同时，解析处理::: demo :::代码块等，解析处理::: demo :::代码块为demo-block vue组件，并传入对应参数.
{
test: /.md$/,
loader: "vue-markdown-loader",
options: {
use: [
[require("markdown-it-container"), "demo", {
validate: function(params) {
return params.trim().match(/^demos*(.*)$/)
},
render: function(tokens, idx) {
var m = tokens[idx].info.trim().match(/^demos*(.*)$/)
if (tokens[idx].nesting === 1) {
var description = (m && m.length > 1) ? m[1] : ""
var content = tokens[idx + 1].content
var html = convert(striptags.strip(content, ["script", "style"])).replace(/(<[^>]*)=""(?=.*>)/g, "$1")
var script = striptags.fetch(content, "script")
var style = striptags.fetch(content, "style")
var jsfiddle = { html: html, script: script, style: style }
var descriptionHTML = description
? md.render(description)
: ""
jsfiddle = md.utils.escapeHtml(JSON.stringify(jsfiddle))
return `
${html}
${descriptionHTML}
`
}
return "
"
}
}],
[require("markdown-it-container"), "tip"],
[require("markdown-it-container"), "warning"]
],
preprocess: function(MarkdownIt, source) {
MarkdownIt.renderer.rules.table_open = function() {
return "";
};
MarkdownIt.renderer.rules.fence = wrap(MarkdownIt.renderer.rules.fence)
return source;
}
}
}
文档编写部分
配置相关的就告一段落了，接下来进入examples中的文档编写部分
一、main.js入口文件编写
在入口文件中，引入相关依赖，项目样式入口、路由、组件以及element-ui
import Vue from "vue"
import App from "./App.vue"
import VueRouter from "vue-router"
// 引入组件
import JY from "../src"
Vue.use(JY)
// 引入element-ui
import ElementUI from "element-ui"
import "element-ui/lib/theme-chalk/index.css";
Vue.use(ElementUI)
// 引入demo-block
import DemoBlock from "./components/demoBlock"
Vue.component("demo-block", DemoBlock)
// 引入项目样式入口
import "./assets/less/index.less"
// 引入路由
import routes from "./route"
Vue.use(VueRouter)
const router = new VueRouter({
routes
})
/* eslint-disable no-new */
new Vue({
render(createElement) {
return createElement(App)
},
router
}).$mount("#app")
二、设置路由配置route.js
路由配置时，将路由路径对应的组件设置为引入的.md文件
import Install from "./docs/install.md"
import QuikeStart from "./docs/quikeStart.md"
import Input from "./docs/input.md"
const routes = [
{
path: "/",
component: Install,
name: "default"
},
{
path: "/guide/install",
name: "Install",
component: Install
},
{
path: "/guide/quikeStart",
name: "quikeStart",
component: QuikeStart
},
{
path: "/input",
name: "input",
component: Input
}
]
export default routes
三、App.vue、以及相关布局组件
1、App.vue
2、header.vue
3、menu.vue
四、重要组件demoBlock.vue
demoBlock组件是解析.md中的::: demo ::: 代码块需要用到的组件，这里的demoBlock.vue文件是copy的element-ui的代码后稍作修改
五、docs中的.md文档文件
.md文件编写时有几个需要注意的地方：
具有交互功能的说明文档，需要有标签，在标签元素中定义需要导出的vue实例。
在:::demo ::: 代码块中定义的模版会作为导出的vue实例的模版，但是在代码块中的中的内容仅作为展示。
.md文件粘贴进来会展示有误，这里只进行了截图，有需要的伙伴可以进入github查看
六、样式调整
样式相关的调整代码这里就不多带带列出来说明了，需要的伙伴可以进入github查看
开发中的调试
设置webpack.dev.conf.js文件的入口为./examples/main.js，这样即可以边开发组件边调试，同时也可以调试到说明文档。
entry: {
app: "./examples/main.js"
},
本文结束啦～希望对你有所帮助。。学无止境，与诸君共勉～～
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/97635.html
-
摘要：测试复制至剪切板的文本测试相关文档复制剪切板滚动至视图内其实，这是一个非常方便的功能，比如说，分页加载后滚动至头部，切换页面时切换至头部。HeyUI组件库
如果你还不了解heyui组件库，欢迎来我们的官网或者github参观。
官网
github
当然，如果能给我们一颗✨✨✨，那是最赞的了！
按需加载
当heyui组件库的组件越来越多的时候，按需加载的功能终于上线了。
话不多说，先把按需...
IamDLY
评论0
收藏0
-
摘要：难道是因为这个组件自带标签胡乱猜疑是解决不了问题的。为何称之为勉强版，因为从上面的也看出来了。再看数组第二个值，这便是一个完整的示例了。也希望能更加努力的学习和进步，更深的理解前端这门艺术
项目使用ElementUI，挺好用的，页面中有些地方的帮助提示通过使用组件Tooltip和el-icon-question来展示，代码如下：
本月累计收益
截图如下：
sho...
-
摘要：不显示下载不显示静音不显示音量条不显示进度条只能播放一个不要快进按钮例如父组件这样回雪月花青春一点点语法大多数时候，我们希望页面上播放一个音频时，其他音频可以暂停。可以把一个类数组转化成数组，这个是我常用的。
showImg(https://segmentfault.com/img/remote/1460000016177005?w=619&h=343);
目的
本项目的目的是教你如...
-
摘要：下面一步步拆解上述流程。切换至分支检测本地和暂存区是否还有未提交的文件检测本地分支是否有误检测本地分支是否落后远程分支发布发布检测到在分支上没有冲突后，立即执行。
背景
最近一直在着手做一个与业务强相关的组件库，一直在思考要从哪里下手，怎么来设计这个组件库，因为业务上一直在使用ElementUI（以下简称Element），于是想参考了一下Element组件库的设计，看看Element构...
男|高级讲师
-
阅读 465·2021-10-09 09:57
-
阅读 469·2019-08-29 18:39
-
阅读 810·2019-08-29 12:27
-
阅读 3026·2019-08-26 11:38
-
阅读 2667·2019-08-26 11:37
-
阅读 1285·2019-08-26 10:59
-
阅读 1375·2019-08-26 10:58
-
阅读 989·2019-08-26 10:48
