Блог

Главная - Вопросы по программированию - JS Doc странно отображает описание

JS Doc странно отображает описание

#jsdoc

Вопрос:

Проблема

Я занят написанием для себя учебника о Дженкинсе, и для этого я использую 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"
  }
}

README.md

 
# LearningJenkins

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

Комментарии:

1. Вы проверили кодировку файла? Я только что бегло просмотрел, и github говорит, что это двоичный файл

2. где я мог бы проверить кодировку файла?

3. Если вы используете VS-код, вы можете открыть файл и посмотреть в правом нижнем углу , где будет написано ANSI , или UTF-xxx , это кодировка. Я схватил файл, и там написано, что это UTF-16 LE (проверьте, чтобы подтвердить). JSDoc не работает с UTF-16 (каждый символ равен 2 байтам вместо 1), поэтому вам нужно будет сохранить этот файл в кодировке UTF-8 (также через VS-код, если вы нажмете на кодировку)

Метки: