diff --git a/README.md b/README.md index af4abae152b13538313c99ad63aa02d1ec0f5de5..e5b52f156a985dbe3e0ae4be831aeacede13c8d2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +

+ logo +

# @agds/cli-plugin-doc **版本** :1.0.9 @@ -296,6 +299,7 @@ const GenDoc = require('@agds/cli-plugin-doc'); | [remark] | string | 文档备注信息,md字符串 | | [renderCode] | [renderCode](#GenDoc.renderCode) | 将`GenDoc.getFileCodes`的返回值渲染成对应的代码段 | | [postfixes] | [Array.<Postfix>](#Postfix) | 后缀内容数组 | +| [logo] | string | logo | @@ -307,7 +311,7 @@ const GenDoc = require('@agds/cli-plugin-doc'); | 属性 | 类型 | 描述 | | --- | --- | --- | -| [id] | string | 锚点的名称,填写之后可以支持 `href=\`#${id}\``锚点定位 | +| [id] | string | 锚点的名称,填写之后可以支持 `href="#${id}"`锚点定位 | | [title] | string | 内容的标题 | | [desc] | string | 内容的描述 | | [content] | string | 内容的正文 | @@ -344,7 +348,10 @@ jsdocToMarkdown配置参数,具体可[👉参考文档](https://github.com/jsd ```ejs <% const {docs, codes, helpers, pkg} = locals -%># <%- pkg.name %> +%><% if(helpers.logo) { %>

+ logo +

+<% } %># <%- pkg.name %> **版本** :<%- pkg.version %> @@ -453,3 +460,33 @@ module.exports = defaultConfig; + + + + +## 许可证 + +[MIT License](https://gitee.com/agile-development-system/cli-plugin-doc/blob/master/LICENSE) +Copyright (c) 2021 锦阳 + + + + + + +## 请维护者喝杯咖啡 + + + + + + + + + + +## 加入钉钉群讨论或加入开发 + + + + diff --git a/agds.doc.config.js b/agds.doc.config.js index 4c9244e488cc00d62455fdb40d4318bcbb39b7d9..1e7ebaa4b55519682792cf2b3de72a59b49a4adf 100644 --- a/agds.doc.config.js +++ b/agds.doc.config.js @@ -5,6 +5,7 @@ const GenDoc = require('./lib/index'); const pkg = require('./package.json'); +const preset = require('@agds/agds-doc-preset'); module.exports = ( /** * 配置参数 @@ -22,6 +23,7 @@ module.exports = ( files: ['./src/**/*.js'], codesDir: './test/*', codesFiles: ['*.js'], + presets: [preset], helpers: { devInstall: true, postfixes: [ diff --git a/package.json b/package.json index c2d6681f97131d167a0838a4e7f338213bad7a8b..5d35a5ac20be211bf4bd1f73d364ab9a115c9816 100644 --- a/package.json +++ b/package.json @@ -51,6 +51,7 @@ "author": "junyang", "license": "MIT", "devDependencies": { + "@agds/agds-doc-preset": "^1.0.4", "@agds/babel-preset-base": "^1.0.0", "@agds/cli-plugin-doc": "^1.0.0", "@agds/eslint-config-js": "^1.0.0", diff --git a/src/index.js b/src/index.js index 7645771c9fb56f00f485bb2f2734dbd3d405ec76..45658b26e17aeccb9803f4c034518d8f4d24ca44 100644 --- a/src/index.js +++ b/src/index.js @@ -246,13 +246,14 @@ function execPromise(command) { * @property {string} [remark] 文档备注信息,md字符串 * @property {GenDoc.renderCode} [renderCode] 将`GenDoc.getFileCodes`的返回值渲染成对应的代码段 * @property {Postfix[]} [postfixes] 后缀内容数组 + * @property {string} [logo] logo */ /** * 后缀内容类型 * * @typedef {Object} Postfix - * @property {string} [id] 锚点的名称,填写之后可以支持 `href=\`#${id}\``锚点定位 + * @property {string} [id] 锚点的名称,填写之后可以支持 `href="#${id}"`锚点定位 * @property {string} [title] 内容的标题 * @property {string} [desc] 内容的描述 * @property {string} [content] 内容的正文 diff --git a/src/template/template.ejs b/src/template/template.ejs index f0fa80f5980ce87edbef3b7c10fe69ad5d697462..db419ac57ea6c38f72d672fd32700b4bcf0814d1 100644 --- a/src/template/template.ejs +++ b/src/template/template.ejs @@ -1,6 +1,9 @@ <% const {docs, codes, helpers, pkg} = locals -%># <%- pkg.name %> +%><% if(helpers.logo) { %>

+ logo +

+<% } %># <%- pkg.name %> **版本** :<%- pkg.version %>