StencilJS中组件中的用法和docs标签

Question

StencilJS https://stenciljs.com/

在为组件生成docs-json输出时，每个组件都有一个用法（和docs）属性，但是我们在文档中找不到关于此的任何提及。

问题：是否添加了用法示例的“用法”属性？如果可以，如何访问它和“文档”？

{
      "filePath": "src\\components\\my-component\\my-component.tsx",
      "encapsulation": "shadow",
      "tag": "my-component",
      "readme": "# my-component\r\n\r\n\r\n\r",
      "docs": "",
      "docsTags": [],
      "usage": {}, // This property here
      "props": [
        {...
}

Answer 1

目前唯一的方法似乎是在您的component / usage文件夹中添加.md文件。

  components/
    my-component/
      usage/
        usage-example.md // This is added to usage
        another-example.md
      my-component.css
      my-component.tsx