JSDo c: Как включить несколько файлов .md - PullRequest
Новая
       71

JSDo c: Как включить несколько файлов .md

0 голосов
/ 07 апреля 2020

Меня впервые попросили написать документацию, и я выбрал способ сделать это с помощью jsdo c.

. Ниже приведен пример конфигурации jsdo c. json. файл для моего jsdo c. Он читает только один файл README.md. 

{
  "source": {
    "include": "./client/src",
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs)"
  },
  "plugins": ["plugins/markdown"],
  "templates": {
    "cleverLinks": true,
    "monospaceLinks": true,
  },
  "opts": {
    "recurse": true,
    "destination": "./docs/",
    "readme": "./README.md"
  }
}

Как мне сделать так, чтобы он читал несколько файлов .md, например, если у меня есть index.md и content.md?

1 Ответ

0 голосов
/ 26 апреля 2020

Я просто хотел сделать ту же функциональность, и подход, который я нашел, не идеален, но он работает достаточно хорошо. В JSDO C есть функция, называемая "учебники".

То, что я сделал, создано в папке root моего проекта "Учебники" и добавлено в раздел "opts" в моей конфигурации. подайте следующее: 

"opts": {
   "tutorials": "./Tutorials",
}

В папке с учебниками вы создаете столько необходимых вам файлов .md, помня, что у каждого учебника должно быть уникальное имя.

Каждый раз, когда вы хотите соедините что-нибудь с указанным c учебником (например, учебник с именем «content.md»), который вам нужно поместить 

{@tutorial content}

. Это работает как в файле Readme.md, так и в любом файле js, в котором есть документация. Также вы можете соединить один учебник с другим.

Подробнее об этой функции вы можете узнать здесь:

https://jsdoc.app/about-tutorials.html

https://jsdoc.app/tags-inline-tutorial.html

мой ответ немного запоздал, но я надеюсь, что это, по крайней мере, поможет вам в будущих проектах :)

...