SLXT // 产品目录名称 src // 书写markdown文件的目录 hello-world.md // 文档markdown文件 book.json // gitbook配置文件，通常不会调整 package.json // 依赖包文件 README.md // 帮助指引文件 SUMMARY.md // 文档目录md文件

# Summary* 成本系统 * 标准扩展接口 * [合同登记](/src/biao-zhun-kuo-zhan-jie-kou/he-tong-deng-ji.md) * [新增合同](/src/biao-zhun-kuo-zhan-jie-kou/he-tong-deng-ji/xin-zeng-he-tong.md) * [编辑合同](/src/biao-zhun-kuo-zhan-jie-kou/he-tong-deng-ji/bian-ji-he-tong.md) * [合同审批](/src/biao-zhun-kuo-zhan-jie-kou/he-tong-deng-ji/he-tong-shen-pi.md) * [合同审批中修改](/src/biao-zhun-kuo-zhan-jie-kou/he-tong-deng-ji/he-tong-shen-he-zhong-bian-ji.md) * [设计变更](/src/biao-zhun-kuo-zhan-jie-kou/she-ji-bian-geng.md) ...

# Summary
* 平台文档 * 基础知识 * [开发基础知识](/src/zi-yuan-yu-gui-fan/tong-yong-ji-shu.md) * DevOps概念及Git基本操作 * [Git基本操作](https://open.mingyuanyun.com/docs/rdc/kuai-su-ru-men/git-ji-ben-cao-zuo.html) * 平台整体介绍 * [开放平台技术白皮书](/src/ping-tai-zheng-ti-jie-shao/kai-fang-ping-tai-bai-pi-shu.md) .... * [集成平台](mip) * [研发协同平台](rdc) * [流程中心](wd_lczx) * [工作流](gzl)* 业务文档 * [售楼系统](slxt) * [成本系统](cbxt) ....

const cheerio = require('cheerio')...// 读取静态html文件内容const fileContent = fs.readFileSync(options.filePath, 'utf8')if (!fileContent) { return Promise.resolve()}let $ = cheerio.load('<div id="_content_">' + fileContent + '</div>')// 匹配第一个h1的标签内容const title =$('h1') .first() .text() || ''// 匹配blockquote标签内容const description = $('blockquote').text() || ''return { title, description}

ElasticSearchClientInstance.index( { index: options['index'], type: options['type'], body: { title: '前端数值计算', // 文章标题 system: '建模平台', // 所属系统 url: '', // 生成的url地址 description: '日常开发中,我们经常遇到浮点数计算不准确问题,为此平台提供了mapnumber数值计算库,用来解决数值计算不准确的问题', // 文档描述，尽量贴近关键词，便于搜索 content: '...', // 文章内容 summary: '...', // 文章摘要 }, }, function(error) { if (!error) { console.log(title + '生成成功') } resolve() })

function search ({ keyword, pageSize, pageIndex, index, system }) { let operator = 'and' if (keyword.match(/[\s +]/)) { operator = 'or' } // 查询条件 let query = { bool: { must: { multi_match: { ... } }, filter: { term: { system } } } } // 处理分页 const from = pageIndex * pageSize // 执行搜索 const { hits } = ElasticSearchClientInstance.search({ size: pageSize, from, index, body: { query } }) ...}

gitbook-plugin-theme-document _assets // 静态资源文件目录 _layouts // 布局模板文件目录 index.js // 主题入口配置文件 package.json // 包描述文件 README.md // 项目说明文件

{ "name": "gitbook-plugin-theme-doc", "dependencies": {}, "description": "文档描述", "license": "ISC", "main": "index.js", "readmeFilename": "README.md", "engines": { "gitbook": ">=3.0.0" }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "version": "1.0.0"}

// index.jsmodule.exports = { // 站点配置 website: { assets: './_assets/', // 插件静态资源目录地址 js: [ // 站点引用的js文件，相对assets目录 'xxxx.js' ], css: [ 'xxxx.css' // 站点引用的css文件，相对assets目录 ] }, // 后面还有关于插入自定义逻辑或增强插件的钩子以及块，这里不做详细介绍，具体可参阅http://gitbook.hushuang.me/plugins/create.html ...}

...<ul class="doc-header-nav"> <!--循环输出导航--> {% for mainNav in book.navigation %} <!--如果配置了链接输出A标签,否则输出SPAN标签--> {% if mainNav.url %} <a href="{{mainNav.url}}" target="{{ mainNav.target}}">{{ mainNav.text }}</a> {% else %} <span>{{ mainNav.text }}</span> {% endif %} <!--如果是个菜单导航，那么输出子级--> {% if mainNav.children %} <span class="doc_trangle"></span> <ul class="doc-header-nav__sub"> {% for subNav in mainNav.children %} <li> <a href="{{subNav.url}}" target="{{ subNav.target}}">{{ subNav.text }}</a> </li> {% endfor %} </ul> {% endif %} </li> {% endfor %}</ul>...

// book.json "title": "开放平台文档", "plugins": [ "theme-doc" // 增加theme-doc的插件依赖 ], "pluginsConfig": {  }, ....

// ~ site/mip/index.vue
<template> <!--在这里可以直接写页面的布局--> <div class="page-mip">MIP主页</div></template><script>// 此处写页面的逻辑export default { name: 'PageMip', data () { return { ... } }, computed: { ... }, methods: { ... }}</script><style>/** * 页面的样式*/.page-mip{ ...}</style>

<template> <img src="/images/conact_us/conact_us_1.svg"></template><style>.page-mip{ background-image: url('/images/conact_us/conact_us_1.svg');}</style>

@class：标明函数是一个构造器函数，意味着需要使用 new 关键字来返回一个实例@function：作为对象的一个函数类型成员@event：描述一个可触发的事件@param：指定要描述参数的名称。还可以包含参数的数据类型@public：标记是否是公开的@returns：记录一个函数的返回值

/** * 格式化数字 * @public * @function * @param {Number} val 要格式化的数字 * @param {String} format 格式字符串,`#,###.000`：保留三位小数,`#,###`：没有小位数 * @example * utility.formatNumber(123123123.123, '#,###.000') // 返回值：123,123,123.123 * utility.formatNumber(123123123.123, '#,###.00') // 返回值：123,123,123.12 * @return {String} 转换后的字符串 */ function formatNumber () { ... }

[{ "description": "<p>设置模式</p>", // 接口描述 "kind": "function", // 接口类型，可以为class、var、function "longname": "AddressSelect#setMode", // 接口完整名称 "name": "setMode", // 接口名称 "memberof": "AddressSelect", // 接口所属父类 "params": [{ // 接口参数 "type": { "names": ["Number"] }, "description": "<p>要设置的模式值</p>", "name": "mode" }], "examples": ["//设置编辑模式\rAddressSelect.setMode(2);\rAddressSelect.getMode(); //return 2;\r//设置查看模式\rAddressSelect.setMode(3);\rAddressSelect.getMode(); //return 3;"] // 接口示例},...

// vue.config.jsmodule.exports = { // 修改 src 为 examples，可以对组件进行测试 pages: { index: { entry: 'examples/main.js', template: 'public/index.html', filename: 'index.html' } }, // 强制内联CSS css: { extract: false }, ...}
// package.json{ "name": "doc-platform-component", ... "scripts": { "serve": "vue-cli-service serve", "build": "vue-cli-service build", "lint": "vue-cli-service lint", "lib": "vue-cli-service build --target lib --name docComponent --dest lib packages/index.js" // 指定打包方式为lib方式 }, ...}

// 生成请求的tokenconst token = 'xxxxxbbbbbcccccddddd=='// 调用jira开放的新增issue接口const request({ method: 'POST', url: 'https://jira.mingyuanyun.com/rest/api/2/issue', headers: { 'cache-control': 'no-cache', 'Authorization': `Basic ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ fields: { project: { id: 'xxxx' }, issuetype: { id: 'xxxx' }, components: [{id: 'xxxx'}], customfield_10204: 'xxxx', summary: `反馈标题`, description: '反馈内容' } })})