angular - Compodoc 包括文档中的图像

Question

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

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

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

1. 在项目的根目录下创建一个文件夹
2. -a用标志命名目录： -a screenshots<-（我读对了吗？）
3. 当npm run compodoc. 它应该复制-a screenshots到documentation/screenshots

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

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

谢谢。

Answer 1

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

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