分析和集成

PostHog

启用分析

您可以在 docs.yml 中定义分析配置。只需为您要连接的平台添加相应条目。

docs.yml

1 analytics:
2   posthog:
3     api-key: ${POSTHOG_API_KEY}
4     endpoint: https://self.hosted.posthog.com/
5   segment:
6     write-key: ${SEGMENT_WRITE_KEY}
7   intercom:
8     app-id: ${INTERCOM_APP_ID}
9     endpoint: https://intercom.custom-instance.com/
10   fullstory:
11     org-id: ${FULLSTORY_ORG_ID}

环境变量

如果您的文档配置是公开的，请不要直接将密钥值写入 docs.yml。请使用 ${VARIABLE_NAME} 语法引用环境变量。

如果您使用 GitHub Workflows 触发文档生成，请确保这些环境变量在工作流运行时可用。

1 - name: Publish Docs
2   env:
3     FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
4     POSTHOG_API_KEY: ${{ secrets.POSTHOG_PROJECT_API_KEY }}
5   run: |
6     npm install -g fern-api
7     fern generate --docs

通过自定义 JavaScript 连接其他集成

企业功能

此功能仅适用于企业计划。如需开始使用，请联系 support@buildwithfern.com。

对于 Fern 在 docs.yml 中没有原生支持的第三方工具，只要它们支持基于 HTML 标签的安装方式，您都可以通过自定义 JavaScript 进行集成。这适用于以下工具：

分析： Amplitude、Heap、Plausible
会话录制： Hotjar、LogRocket、Microsoft Clarity
支持和聊天： Zendesk、Crisp、Drift
标签管理器： Adobe Launch、Tealium

将供应商的 <script> 代码片段粘贴到自定义 JS 文件中，并在 docs.yml 中引用：

docs.yml

1 js: ./custom.js

1	analytics:
2	posthog:
3	api-key: ${POSTHOG_API_KEY}
4	endpoint: https://self.hosted.posthog.com/
5	segment:
6	write-key: ${SEGMENT_WRITE_KEY}
7	intercom:
8	app-id: ${INTERCOM_APP_ID}
9	endpoint: https://intercom.custom-instance.com/
10	fullstory:
11	org-id: ${FULLSTORY_ORG_ID}

1	- name: Publish Docs
2	env:
3	FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
4	POSTHOG_API_KEY: ${{ secrets.POSTHOG_PROJECT_API_KEY }}
5	run: \|
6	npm install -g fern-api
7	fern generate --docs