2016-10-14 8 views
0

나는 jsdocdocdash으로 시작하고 있으며 모든 것이 지금까지 괜찮을 것 같습니다. 그러나 비록 내 모듈과 같은 천천히 내가 생성 된 파일 index.html에 항목을 추가하는 방법을 알아 낸하지 않은 문서화되고있다. 루트 HTML 파일에 항목을 생성하기 위해 파일에 필요한 마크 업은 무엇입니까?JSDoc index.html 페이지 채우기

더 많은 참조를 위해 왼쪽 탐색 창 상단에는 "홈"링크가 있습니다. 이것은 내가이 질문을 할 때 언급하고있는 것입니다. 링크는 본질적으로 빈 페이지로 이동하지만, 아래의 다른 모든 링크는 주석의 정확한 문서를 가지고 있습니다.

답변

0

documentation은이를 수행하는 방법에있어 다소 오해의 소지가 있습니다. README.md 파일이 원본 디렉토리 내에 있으면 index.html 파일로 찾은 첫 번째 파일을 사용합니다. 이것은 전적으로 사실이 아닙니다. 또한 사용할 README.md 파일의 경로를 지정해야합니다.

jsdoc -c jsdoc.json --readme ./README.md