Jsdoc-to-markdown

需求

JSDOC生成的文档（html）和现在开发者网站要求的文档格式（markdown）不一致，导致API文档展示不够理想。

调研结果

JSDOC直接生成MD：https://github.com/jsdoc2md/jsdoc-to-markdown，使用demo文件可以直接生成，也可支持ts。

优化方案

1．通过工具jsdoc-to-markdown将js内容生成为md格式文件，与内容文档一致
2．读取不成功的类，跳过，并将错误原因写入log；
3．生成文档索引json文件，便于入库和索引

运用实例

命令 node jsdoc2md.js
参考
https://github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-create-one-output-file-per-class

Jsdoc2md.js

'use strict'
const jsdoc2md = require('jsdoc-to-markdown')
const fs = require('fs')
const path = require('path')/* input and output paths */
const inputFile = 'example.js'
const outputDir = __dirname/* get template data */
const templateData = jsdoc2md.getTemplateDataSync({ files: inputFile })/* reduce templateData to an array of class names */
const classNames = templateData.reduce((classNames, identifier) => {if (identifier.kind === 'class') classNames.push(identifier.name)return classNames
}, [])/* create a documentation file for each class */
for (const className of classNames) {const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`console.log(`rendering ${className}, template: ${template}`)const output = jsdoc2md.renderSync({ data: templateData, template: template })fs.writeFileSync(path.resolve(outputDir, `${className}.md`), output)
}

Jsdoc-to-markdown相关推荐

jsdoc安装与配置
0 环境本文档采用npm版本为6.11.3 jsdoc官网 1 使用NPM安装JSDoc 首先,新建一个工程目录,不妨为jsdoc_demo.创建完成后进入目录执行 npm init -y 生成一 ...
jsdoc接口文档生成器
jsdoc 官方文档 https://jsdoc.app/ 快速入门需要安装node.js 及npm 环境 step.1 安装创建一个新文件夹myJsdoc mkdir myJsdoc cd my ...
jsdoc api文档_创建更好的JSDoc文档
jsdoc api文档 Writing code documentation is one of the most relaxing experiences of my work as a back ...
JSDoc 安装教程
环境 nodeJs v10.17.0 jsdoc v3.6.3 操作说明全局安装jsdoc最新版 npm install jsdoc -g 全局安装jsdoc 指定v3.6.3版本 npm inst ...
lisp协议instand_分享|Linux 上 10 个最好的 Markdown 编辑器
在这篇文章中,我们会点评一些可以在 Linux 上安装使用的最好的 Markdown 编辑器. 你可以在 Linux 平台上找到非常多的的 Markdown 编辑器,但是在这里我们将尽可能地为您推荐 ...
【其他】将幕布文章OPML转换为Markdown的方法
使用幕布可以快速地进行笔记中格式缩进和笔记管理等操作,但是,幕布只提供了Word.PDF.图片.HTML.OPML.思维导图的导出,以下是把幕布的大纲转换成Markdown的方法. 1.先把幕布里的文 ...
【注意事项】Markdown遇到的小问题
写博客的目录的时候遇到了一个小问题在博客三级标题里插入了一个超链接,在正文里看显示格式是正常的但是文章开头的目录中却出现了显示异常的问题,把Markdown代码直接显示出来了后来发现是文本里面[ ...
推荐几个微信Markdown排版工具
Md2All Markdown Nice WeChat Format 参考链接原文链接
Markdown入门简介
参考 http://sspai.com/25137 作者: Te_Lee 文章来源: 少数派 Markdown入门简介(使用工具Haroopad) 一.使用的工具----haroopad(http:/ ...
atom搭建markdown环境
1. 搭建markdown环境 > 禁用atom自带的markdown-preview插件(功能简单) > 安装插件:markdown-preview-plus@2.4.16(在markd ...

Jsdoc-to-markdown

需求

调研结果

优化方案

运用实例

Jsdoc-to-markdown相关推荐

最新文章

热门文章