首页 > 解决方案 > JS Doc 奇怪地显示描述

问题描述

问题

我正忙着为自己写一个关于 jenkins 的教程,我正在使用 jsdoc 来做这件事。无论如何,我在主页上注意到读取 Readme.md 的部分显示非常奇怪。

在此处输入图像描述

jsdoc.json

{
  "source": {
      "include": ["src"],
      "includePattern": ".+\\.js(doc|x)?$",
      "excludePattern": "(node_modules/|docs)_"
  },
  "plugins": ["plugins/markdown"],
  "tags": {
      "allowUnknownTags": true,
      "dictionaries": ["jsdoc","closure"]
  },
  "templates": {
      "cleverLinks": true,
      "monospaceLinks": true
  },
  "opts":{
      "recurse": true,
      "destination": "./docs/",
      "tutorials": "./tutorials",
      "readme": "README.md"
  }
}

自述文件.md


# LearningJenkins

## Tutorials
<!-- [Link to tutorials](https://codenameninja.github.io/LearningJenkins/) -->

标签: jsdoc

解决方案


推荐阅读