Docusaurus:记录项目的出色工具

创建软件时最重要的任务之一就是文档,不幸的是,对于那些从事这项工作的人来说,有时候看起来很乏味,但是对于任何人来说,好的文档可以成为任何工具成功的关键并不是什么秘密,因为提供给用户的帮助,帮助他们了解应用程序的正确操作或提供给其他开发人员的信息以改善应用程序。

有很多优秀的应用程序可以使我们以简单的方式来记录项目,有些倾向于提供超出我们真正想要的功能,有些则需要复杂的安装, 记录项目的工具 符合且非常易于使用和安装的Docusaurus。

什么是Do龙?

cus龙 是一个项目 构建,实施和维护开源工具Web文档,它允许使用该语言 降价 以相同的方式编写文档,以稍后将其发布为html网站,该工具允许我们使用React扩展和自定义文档网站的设计。

通常,由Facebook编程团队开发的开放源代码工具使我们能够轻松创建美观而轻松的网站,在这里我们可以正确显示任何项目的文档。

该工具具有用于正确版本化文档的功能,高级搜索引擎,可以实时记录和重新设计我们的文档站点的功能,与翻译的集成以及许多其他功能,这些功能将帮助您减少对文档编制的担心,而不必担心文档制作过程更加轻松,并且效果更加令人满意。

在其开发者分发的以下gif文件中可以看到Docusaurus的易于使用

如何安装Docusaurus?

Docusaurus的主要目标是成为记录在github上托管的开源应用程序的权威工具,因此在此平台上安装和运行您的文档网站确实非常容易。

要开始在Github上享受Docusaurus,只需按照开发团队指示的步骤进行,我们在下面引用:

  1. 转到GitHub存储库目录的根目录,您将在其中创建文档并运行以下命令:
  2. yarn global add docusaurus-init or npm install --global docusaurus-init
  3. docusaurus-init

最终结果将是创建文件和目录结构,如下所示:

记录项目的工具


发表评论,留下您的评论

发表您的评论

您的电子邮件地址将不会被发表。 必填字段标有 *

*

*

  1. 负责数据:MiguelÁngelGatón
  2. 数据用途:控制垃圾邮件,注释管理。
  3. 合法性:您的同意
  4. 数据通讯:除非有法律义务,否则不会将数据传达给第三方。
  5. 数据存储:Occentus Networks(EU)托管的数据库
  6. 权利:您可以随时限制,恢复和删除您的信息。

  1.   胡安·何塞

    尝试有趣的错误!