@agds/agds-doc-preset

版本 ：1.0.8

agds的统一的doc配置

快速开始

安装

npm i -D @agds/agds-doc-preset

引入

// .agds.doc.config.js
const preset = require('@agds/agds-doc-preset');
module.exports = {
    presets: [preset],
};

配置源码

const GenDoc = require('@agds/cli-plugin-doc');
const { FastPath, FastFs } = require('@agds/node-utils');
const pkgPath = FastPath.getCwdPath('package.json');
const path = require('path');
let pkg = {};
let repository;
if (FastFs.getPathStatSync(pkgPath)) {
    pkg = require(pkgPath);
    try {
        const repoName = pkg.repository.url.match(/^(https:\/\/|git@)gitee\.com(\/|:)agile-development-system\/(?<repoName>[\w-]+).git$/).groups.repoName;
        repository = 'https://gitee.com/agile-development-system/' + repoName;
    } catch (error) {
    }
}

module.exports = (
    /**
     * 配置参数
     *
     * @returns {GenDoc.RenderOptions}
     */
    async () => {
        return {
            output: 'README.md',
            helpers: {
                devInstall: true,
                postfixes: [
                ],
            },
            /**
             * 最后处理的函数
             *
             * @param {GenDoc.RenderOptions} config 文档配置
             */
            modify(config) {
                config.helpers.postfixes.push(
                    {
                        id: 'license',
                        title: '许可证',
                        content: `${repository ? `[MIT License](${repository + '/blob/master/LICENSE'})` : 'MIT License'}\nCopyright (c) 2021 锦阳`,
                    },
                    {
                        id: 'donate',
                        title: '请维护者喝杯咖啡',
                        content: getRelativeCode('./docs/donate.md'),
                    },
                    {
                        id: 'dingtalk',
                        title: '加入钉钉群讨论或加入开发',
                        content: getRelativeCode('./docs/dingtalk.md'),
                    },
                );
                config.helpers.logo = 'https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/logos/light/1.png';
            },
        };
    }
)();

/**
 * 获取绝对路径的文件内容
 *
 * @param {string} filename 文件名
 * @returns {string}
 */
function getRelativeCode(filename) {
    return GenDoc.getFileContent(path.join(__dirname, filename));
}

许可证

MIT License Copyright (c) 2021 锦阳

请维护者喝杯咖啡

加入钉钉群讨论或加入开发