Compodoc 在文档中包含图像
Compodoc incldue images within docs
这是一个 Angular 项目,使用 compodoc 来帮助记录项目。
在 compodoc > demo 中,他们展示了一些带有图像的文档示例,我试图在我的项目中复制它,但无法使其工作。
我已按照 thread 说明进行操作。据我了解,步骤如下:
- 在项目的根目录下创建一个文件夹
- 用
-a
标志命名目录:-a screenshots
<-(我没看错吗?)
- 当
npm run compodoc
。它应该将 -a screenshots
复制到 documentation/screenshots
对我来说,它不是将资产文件夹复制到 documentation
目录中。有谁知道如何使这项工作? Compodoc的文档没有讲到如何包含图片。
我的文件结构的屏幕截图:
谢谢。
-a
是一个标志并且是 shorthand for --assetsFolder
.
- 创建一个文件夹,例如'screenshots' 在项目的根目录下
- 在 markdown 中引用您的图片,例如

- 使用
compodoc -p tsconfig.json -a screenshots -s
到 运行 compodoc 并复制您的资产文件夹
这是一个 Angular 项目,使用 compodoc 来帮助记录项目。
在 compodoc > demo 中,他们展示了一些带有图像的文档示例,我试图在我的项目中复制它,但无法使其工作。
我已按照 thread 说明进行操作。据我了解,步骤如下:
- 在项目的根目录下创建一个文件夹
- 用
-a
标志命名目录:-a screenshots
<-(我没看错吗?) - 当
npm run compodoc
。它应该将-a screenshots
复制到documentation/screenshots
对我来说,它不是将资产文件夹复制到 documentation
目录中。有谁知道如何使这项工作? Compodoc的文档没有讲到如何包含图片。
我的文件结构的屏幕截图:
谢谢。
-a
是一个标志并且是 shorthand for --assetsFolder
.
- 创建一个文件夹,例如'screenshots' 在项目的根目录下
- 在 markdown 中引用您的图片,例如

- 使用
compodoc -p tsconfig.json -a screenshots -s
到 运行 compodoc 并复制您的资产文件夹