Documentation Insights
Scarf 可以根据项目文档页面、README 和其他网络属性的网络流量显示洞察力，从而帮助您了解人们和公司如何发现和了解您的项目。 Scarf 提供轻量级、无 cookie 的分析像素，可以在您阅读内容的互联网上的任何地方使用。 与传统的基于 JavaScript 的 Web 分析不同，基于图像的遥测在无法访问 JavaScript 执行的地方工作。 不使用 cookie 意味着不需要烦人的 cookie 横幅，并且您的读者在继续网上冲浪时永远不会被跟踪。
如果您观察到来自特定公司的读者经常查看您的项目文档，这可能表明有机会获得支持合同或赞助来为您的项目提供财务支持。 在您的文档中看到某些页面的重复访问者可能会暗示您的项目的某些部分令人困惑或可以澄清。
将 Documentation Insights 与 Scarf 的包分析相结合可以帮助您更好地了解您的 OSS 用户旅程以及相关的转化率。 鉴于有人看到了您的登录页面，他们继续下载您最新的二进制文件、容器映像或其他工件的可能性有多大？
特征
Scarf 的项目 Documentation Insights 提供了以下方面的洞察力：
- 哪些企业正在查看您的项目文档。
- 与此 Web 流量关联的聚合位置信息。
- 您文档的哪些部分被查看最多。
- 使用可在 README（或通常呈现的文档）、电子邮件和 Web 上通常不执行 JavaScript 的其他地方使用的工具。
- 从查看文档到下载中间件的转化率。
如何运行？
Scarf 通过一个简单的透明跟踪像素收集网络流量洞察。 您从 Scarf 复制一个 <img> 标签到您项目的README、文档或任何其他网络资产中，每当用户从我们这里加载图像时，Scarf 将查找与该地址相关的任何业务元数据并将该信息通过您的免费 Scarf 帐户显示给您 （只有您）。 Scarf 本身不存储 IP 地址，因此不会收集任何个人身份信息。
入门
前往您的 Scarf 仪表板并找到 Documentation Insights Management 部分。 为您的像素命名，并可选择将其附加到您在 Scarf 上管理的包。 单击 "copy" 按钮将 <img> 标签复制到剪贴板，然后将标签粘贴到项目的自述文件、文档和任何其他您想要收集有关谁在使用您的文档页面的信息的 Web 属性中。
注意事项
数据精度
来自 Documentation Insights 数据的查看次数应被视为近似值而非精确值。 页面加载是一个嘈杂的信号，Scarf 为您的跟踪像素提供服务的基础设施经过优化，可以始终快速加载并且永远不会妨碍，而不是有一个准确的页面加载计数。
来源
基于像素的遥测将在标准网页上工作，在 npm 和 PyPi等包注册网站上呈现markdown文档，以及任何可以嵌入图像的地方，但 GitHub 是一个明显的例外。当 GitHub 呈现 markdown 时，它会将 URL 从其原始网址重写为 https://camo.githubusercontent.com/