Docs by Hashnode

无头模式和 GraphQL 支持

您可以通过无头模式和 GraphQL 支持来掌控一切。轻松集成您的文档，无缝扩展，并为您的开发者提供所需的灵活性。

自定义域名和品牌

为您的用户映射自定义域名，以获得流畅的品牌化体验。

自定义页面

您可以轻松在文档中创建自定义页面，使您的团队能够灵活地添加额外的内容和资源，以满足您的特定需求。

最佳的 MDX 支持的编辑器

我们的视觉 WYSIWYG 编辑器，由 MDX 支持，使您可以创建交互式文档，将 Markdown 与 React 组件无缝结合。

闪电般快的速度和 SEO 优化

我们的文档经过 SEO 优化，并在 Lighthouse 测试中表现出色，确保为您的用户提供快速的性能。

AI 驱动的搜索和聊天

对于希望提升搜索功能的团队，请升级到 AI 驱动的搜索。这个更智能的选择将演变成类似聊天的体验，让用户更轻松地找到正确的内容。

Algolia 驱动的超快搜索

立即找到您需要的内容。我们由 Algolia 提供支持的搜索功能提供快速、可靠的结果，让您的用户能够持续前进。

API 参考游乐场

通过一键导入 OpenAPI 规范，快速设置 API 参考。快速、开发人员友好，专为现代团队设计。

显示自定义代码示例

我们的文档可以为您的 API 自动生成代码示例，但您也可以添加自定义示例。无论是 JavaScript、Python 还是其他语言，都显示清晰的代码片段，帮助开发者快速理解和使用您的 API。

分析和智能

通过详细的分析和智能报告，了解您的文档的使用情况，帮助您改进内容。

用户反馈功能

让用户直接从文档中发送反馈。获取有关 API 性能的见解，接受错误报告，更正错别字，并增强指南 - 所有这些都可以在一个地方完成。

扩展到无限成员

将您的团队扩展到无限成员，允许每个人为您的文档做出贡献，无论您的组织规模如何。

版本控制和权限

通过强大的版本控制和权限来保持控制权，非常适合管理复杂的文档工作流程。

实时编辑

与您的团队实时协作，即时更新，保持一致，避免版本冲突。

行内评论

在编辑器中使用行内评论简化反馈。团队成员可以审查和建议改进，在每个步骤中保持清晰度和准确性。

具有角色的协作工作流程

为您的团队成员分配角色，以管理谁可以编辑、审查或批准文档。通过将正确的工作分配给正确的人员来保持工作流程的有序性。

• 软件公司：使用 Docs by Hashnode 的 MDX 编辑器和无缝 GitHub 集成，简化 API 文档的创建和管理。
• 开发团队：使用 Docs by Hashnode 的实时编辑和内联评论功能，增强文档项目的协作。
• 初创公司：使用 Docs by Hashnode 的一键式 OpenAPI 导入功能，快速构建和部署高质量的 API 参考文档。
• 企业：使用 Docs by Hashnode 的企业级功能（包括 SSO 和自定义 SLA）安全地管理和扩展开发者文档。
• 技术作家：使用 Docs by Hashnode 的 AI 供电搜索和可视化所见即所得编辑器，创建互动且引人入胜的开发者文档。

Docs by Hashnode 是什么？

Docs by Hashnode 是一款为 API 文档和产品指南打造的内容引擎。借助 Docs by Hashnode，您可以轻松创建、定制和扩展开发者文档和 API 参考。

如何开始使用 Docs by Hashnode？

您可以在 https://hashnode.com/projects 上注册并开始创建您的第一个文档。

Docs by Hashnode 的定价如何？

Docs by Hashnode 提供免费、初创公司和企业计划。您可以访问 https://hashnode.com/products/docs#pricing 查看完整的定价表。

Docs by Hashnode 相对于其他文档平台有什么优势？

Docs by Hashnode 提供完整的控制权、无缝的品牌集成、AI 驱动的搜索、一键式设置 Swagger/OpenAPI 规范以及与您的产品一起发展的动态、可扩展的文档。

Docs by Hashnode 是否提供任何集成？

Docs by Hashnode 集成了 Swagger/OpenAPI 规范，允许您一键设置 API 参考。此外，它还支持无头模式和 GraphQL，允许您轻松将文档集成到您的应用程序中。

• 首先，创建一个 Hashnode 账号或登录您已有的账号以访问 Docs by Hashnode 平台。这是使用该服务的第一步。
• 选择一个符合您需求的套餐；方案从免费套餐到企业级解决方案不等，提供不同的功能和可扩展性。
• 在平台内创建您的文档项目。选择项目名称并选择相关设置，例如自定义域名或无头模式。
• 利用内置的 MDX 编辑器来创作或导入您的文档内容。使用 Markdown 和 React 组件来创建动态内容。
• 利用 AI 驱动的搜索功能（可选升级）来优化搜索能力和用户体验，从而提高可发现性。
• 配置 API 参考集成（如果适用），利用一键导入 OpenAPI 规范的功能来与 API 集成。
• 使用可用的品牌选项（例如自定义域名）来自定义文档的外观，使其与您组织的标识相符并增强用户体验。
• 使用实时编辑功能和内联审查功能与您的团队协作；分配角色并管理权限以优化团队工作流程。
• 监控分析以评估用户参与度并确定改进领域，从而为内容优化和持续开发提供见解。
• 发布您的文档，使其能够被您的目标受众和用户访问；使用版本控制来管理不同的迭代和更新。