“注释”生成“VitePress文档网站”只需要“一行命令”！来试试！

jsdoc2vitepress init

.
├─ docs
│  ├─ .vitepress
│  │  └─ config.js
│  │  └─ jsdoc2vitepress.config.js
│  └─ index.md

// init-docs.ts
import ora from 'ora';
import fs from 'fs-extra';
import gitclone from 'git-clone/promise';
import path from 'path';

/**
 * @module init-docs
 * @description init docs directory
 */

/**
 * @exports initDocs "jsdoc2vitepress init" init docs directory
 */
export const initDocs = async () => {
  const loading = ora('Init docs directory');
  try {
    const templateGitUrl = 'https://github.com/luciozhang/jsdoc2vitepress-template.git';
    const docsDir = path.resolve(process.cwd(), 'docs');
    await gitclone(templateGitUrl, docsDir, { checkout: 'master', shallow: true });
    fs.removeSync(path.join(docsDir, '.git'));
    loading.succeed('Init docs directory success');
  } catch (error) {
    loading.fail(`Init docs directory fail: ${error}\nPlease delete local 'docs' directory and retry.`);
  }
};

// jsdoc-to-md.ts
import fs from 'fs-extra';
import path from 'path';
import jsdoc2md from 'jsdoc-to-markdown';
import ora from 'ora';

const configJ2VPath = path.resolve(process.cwd(), 'docs', '.vitepress', 'jsdoc2vitepress.config.json');
const configJ2MPath = path.resolve(process.cwd(), 'docs', '.vitepress', 'jsdoc2md.config.json');

/**
 * @module jsdoc-to-md
 * @description Generates Markdown API documentation from jsdoc annotated source code.
 */

/**
 * @exports jsdocToMd Generates Markdown
 * @returns {Promise} Return promise to check if generate success
 */
export const jsdocToMd = async () => {
  const loading = ora('Generates Markdown');
  try {
    const { markdownDirs } = await fs.readJSON(configJ2VPath);

    await Promise.all(markdownDirs.map(async (sourceObject: any) => {
      const { root, output, ingoreList } = sourceObject;
      await makeMarkDownForFiles(root, output, ingoreList);
    }));
    loading.succeed('Generates Markdown success');
  } catch (error) {
    loading.fail(`Generates Markdown fail${error}`);
  }
};

const makeMarkDownForFiles = async (root: string, output: string, ingoreList: Array<string>) => {
  const fileList = await fs.readdir(root);
  await Promise.all(fileList.map(async (fileName) => {
    if (ingoreList.indexOf(fileName) === -1) {
      await makeMarkDownDoc(fileName, root, output);
    }
  }));
};

const makeMarkDownDoc = async (sourceName: string, sourceRootPath: string, outputPath: string) => {
  let sourcePath = `${sourceRootPath}/${sourceName}`;
  const outputName = sourceName.replace('.js', '').replace('.ts', '');

  const loading = ora(`Generates Markdown for ${sourcePath}`);
  try {
    // 处理js文件的路径，需要区分是文件或目录，目录会将目录下所有文件生成为一个md
    const stat = fs.lstatSync(sourcePath);
    if (stat.isDirectory()) {
      sourcePath = `${sourcePath}/*`;
    }

    const mdStr = await jsdoc2md.render({
      'example-lang': 'javascript',
      files: path.resolve(process.cwd(), sourcePath),
      'name-format': 'backticks',
      'heading-depth': 2,
      'module-index-format': 'none',
      configure: path.resolve(process.cwd(), configJ2MPath),
    });
    if (mdStr) {
      fs.outputFile(path.resolve(process.cwd(), `${outputPath}/${outputName}.md`), mdStr);
      loading.succeed('Generates Markdown success in ' + `${outputPath}/${outputName}.md`);
    }
  } catch (error) {
    loading.fail(`Generates Markdown fail for ${sourcePath}`);
  }
};

//md-to-vitepress.ts
import shell from 'shelljs';
/**
 * @module md-to-vitepress
 * @description Generates VitePress API documentation from jsdoc annotated source code.
 */

/**
 * @exports startVitePress Run VitePress server
 * @returns {Promise} Return promise to check if run success
 */
export const startVitePress = async () => {
  shell.exec('node_modules/.bin//vitepress dev docs');
};

/**
 * @exports buildVitePress build VitePress server
 * @returns {Promise} Return promise to check if build success
 */
export const buildVitePress = async () => {
  shell.exec('node_modules/.bin/vitepress build docs');
};

// index.ts
#!/usr/bin/env node

import { Command } from 'commander';
import { initDocs } from './init-docs';
import { jsdocToMd } from './jsdoc-to-md';
import { startVitePress, buildVitePress } from './md-to-vitepress';

const program = new Command();

program
  .name('jsdoc2vitepress')
  .description('Generates vitepress API documentation from jsdoc annotated source code.')
  .version('1.0.0');

program
  .command('init')
  .description('init vitepress directory.')
  .action(async () => {
    await initDocs();
  });

program
  .command('start')
  .description('Generates vitepress API documentation from jsdoc annotated source code and run Vitepress')
  .action(async () => {
    await jsdocToMd();
    await startVitePress();
  });

program
  .command('build')
  .description('Generates vitepress API documentation from jsdoc annotated source code and run Vitepress')
  .action(async () => {
    await jsdocToMd();
    await buildVitePress();
  });

program.parse();

jsdoc2vitepress init
jsdoc2vitepress start

jsdoc2vitepress build