Compodoc 在文档中包含图像

Question

这是一个带有 compodoc 的 Angular 项目，用于帮助文档项目。

在 compodoc > demo 他们展示了一些带有图像的文档示例，我试图在我的项目中复制它但无法使其工作。

我已按照thread 的说明进行操作。据我了解，步骤如下：

1. 在项目的根目录下创建一个文件夹
2. 使用-a 标志命名目录：-a screenshots
3. 当npm run compodoc。它应该将-a screenshots 复制到documentation/screenshots

对我来说，它不会将资产文件夹复制到 documentation 目录中。有谁知道如何使这项工作？ Compodoc 的文档没有讨论如何包含图像。

我的文件结构的屏幕截图：

谢谢。

Answer 1

-a 是一个标志，是--assetsFolder 的简写。

1. 创建一个文件夹，例如项目根目录中的“屏幕截图”
2. 在 markdown 中引用您的图片，例如![Screenshot-1](screenshots/homepage.png)
3. 使用compodoc -p tsconfig.json -a screenshots -s 运行compodoc 并复制您的资产文件夹