Docusaurus官方版

Docusaurus简介

Docusrus提供文档型网站开发功能，可以在本软件中搭建博客系统，在本软件中搭建论坛系统，社区系统，通过部署本软件发布内容。你可以为新建的网站发布博客内容，添加新的博客标题，插入额外的资源，从而立即在网站上发布新的文章内容，满足用户对网站建设的需求。用户可以快速建立个人使用的博客系统，或者开发评论系统，方便网友在网站上发表评论。这个软件功能还是很丰富的。用户可以自行配置软件界面模块，添加本地化语言，控制版本，配置帖子搜索方案，设置导航和侧边栏内容，轻松搭建博客式网站！

Docusrus软件功能

1.版本控制

您可以使用版本脚本根据docs目录中的最新内容剪切新的文档版本。，即使docs目录中的文档不断更改，特定的文档集也将被保留并可访问。

2.翻译和本地化

Docusrus允许Cwdin用于有用的翻译功能。用英文写的文档上传到Cwdin，供社区用户翻译。您可以通过用标签包装任何要翻译的字符串来翻译用英语字符串编写的顶级页面。其他标题和标签也将被找到并正确翻译。

3.将文档添加到边栏

很多时候，您会希望将文档添加到与网站顶部导航栏中的一个标题相关联的边栏中。侧边栏是最常见的侧边栏，它是Docusrus初始化时安装的docs侧边栏。

4.链接文件

新的降价文件文档将在网站上显示为页面。首先，使用id的每个文件头中的创建到这些文件的链接。如果没有id字段，文件名将用作链接名。

例如，创建一个空文件(例如，docs/入门. md)会使新页面成为L/docs/docs/入门. html

5.参考站点文档

如果您想引用docs目录中的另一个文档(或可选的customDocsPath路径站点配置选项设置的位置)，只需使用要引用的文档的名称。

6.启用搜索

Docusrus支持使用Algolia DocSearch进行搜索。网站上线后，可以提交到DocSearch。，Algolia将向您发送凭据，您可以将其添加到您的siteConfig.js中

DocSearch的工作原理是每24小时抓取一次网站内容，并将所有内容放入Algolia索引中。使用Algolia API直接从您的前端查询此内容。请注意，您的网站需要公开才能正常工作(也就是说，它不在防火墙后面)。这项服务是免费的。

7.自定义页面

您可以将不属于标准文档或博客折扣文件的页面添加到您的网站。您可以通过添加。js文件到网站/页面目录。这些文件是React组件，调用render()来创建它们，并得到CSS类等的支持。

Docusrus软件特色

开发和部署

使用附件实时进行设计和文档更改。使用脚本或与CircleCI的持续集成，将您的网站手动发布到GitHub页面或其他静态文件主机。

网站功能

Docusrus目前提供支持，帮助您的网站使用翻译、搜索和版本控制以及其他特殊的文档降价功能。如果你对有用的功能有什么想法，请随时在GitHub上投稿！

文档版本控制

在项目的所有版本上支持用户。文档版本控制可以帮助您保持文档与项目版本同步。

文档搜索

让您的社区很容易在文档中找到他们需要的内容。我们很荣幸支持Algolia文档搜索。

由Markdown支持

节省时间，专注于项目文档。只需使用Markdown和Docusrus编写文档和博客文章，他们就会发布一组静态html文件供使用。

使用反应来构建

通过重用React扩展或自定义项目的布局。当重复使用相同的页眉和页脚时，可以扩展Docusrus。

准备翻译

本地化是预先配置的。使用Cwdin将您的文档翻译成70多种语言。

Docusrus教程

设置您的网站

Docusrus的创建是为了方便您为开源项目创建网站和文档。

在安装和准备之后，已经做了大量工作来为您的文档创建基本站点。

场地结构

您的网站结构如下:

假设您删除了。md是用初始化脚本安装的。

您所有的文档文件都应该放在docs作为markdown.md文件的目录中。任何博客文章都应该在博客目录中。

博客的格式必须是yyyy-mm-DD-your-file-name.md。

创建您的基本网站

要创建一个功能齐全的网站，您只需要执行几个步骤:

1.将文档/文档添加为。md文件，以确保每个文件都有正确的标题。下面的id是一个示例标题，其中链接名(例如，docs/int.html)和标题是网页的标题。

2.在sidebars.json文件中添加零个或多个文档，以便在选择时在边栏中显示文档。

如果文档没有被添加到sidebars.json文件中，这些文档将被呈现，但是它们只能链接到其他文档，并使用已知的l进行访问。

3.根据文档中的注释和指南进行更改。网站/siteConfig.js使用配置文件来配置您的网站。网站/siteConfig.js

4.创建任何自定义页面和/或自定义为网站提供页脚的网站/core/Footer.js文件。

5.将资产(如图像)放在网站/静态/目录中。

6.运行网站以查看更改结果。

特殊定制

文档登录页

如果您希望目标网页直接指向您的文档，您可以重定向它。

1.index.js从网站/pages目录(如果存在)中删除该文件。

2.将包含以下内容的自定义静态index.html页面网站/静态添加到目录中:

您将获取id文档的，并将其放在的元数据上。md文档页面。

添加博客

初调

要设置您网站的博客，请首先在博客中创建一个目录您的回购网站目录。

，将标题链接siteConfig.js添加到您的博客中:

添加帖子

要在博客中发布，请在博客目录中创建一个名为yyyy-mm-DD-my-blog-post-title . MD的文件。过帐期间是从文件名中提取的。

例如在网站/博客/2017年12月14日-Intducing-docurus.md上:

添加slug将覆盖博客文章的网址。

示例:

Https将在以下位置提供://网站/博客/intuiting-docurus

标题选项

唯一的必填字段是标题；；但是，我们提供向您的博客文章添加作者的选项和其他选项。

thor-作者签名的文本标签。

与作者有关联。这可以是推特、GitHub、脸书账号等。

ThorFD-FacebookID用来获取图片。

作者图片的网址。(注意:如果同时使用thorFD和thorImageL，则thorFD将具有优先权。如果钍射气需要钍射气显示，则不包括在内。)

标题-博客文章的标题。

博客文章的链接。示例:/blog/my-test-slug。如果未指定，将从文件名中提取博客L段。

未列出-你可以直接访问l来访问这篇文章，但它不会显示在最终版本的侧栏中；在当地发展期间，该职位仍将被列出。当您希望与他人共享在制品帖子以获取反馈时，此功能非常有用。

草稿-如果设置为，此帖子将不会显示为真。在WIP中有用，但不想分享帖子。

抽象截断

使用博客文章中的标签来指示在查看所有已发布的博客文章时将显示为摘要的内容。以上内容将是总结的一部分。示例:

更改边栏中显示的博客文章数量

默认情况下，边栏显示五篇最近的博客文章。

您可以通过将blogSidebarCount设置添加到来配置要显示的特定数量的博客文章siteConfig.js。

可用选项是表示您想要显示的帖子数量的整数或带值的字符串& # 8217；所有& # 8217；。

示例:

blogSidebarCount:& # 8216；所有& # 8217；,

复制

更改边栏标题

您可以通过添加blogSidebarTitle设置来配置特定的侧栏标题siteConfig.js。

这个选项是一个对象，所有的键都可以使用。您可以通过为指定值deflt来更改默认边栏标题。如果all将blogSidebarCount选项设置为，您可以为指定一个值来更改侧栏标题& # 8217；所有& # 8217；。

示例:

真正简单的联合

Docusrus为你的博客文章提供RSS源。并且支持RSS Atom提要格式。这些数据将自动添加到您网站页面的HTML标记中。

RSS源提供了一个帖子文本的摘要，直到。如果找不到标签，将使用不超过250个字符的所有文本。

社交按钮

如果你想在博文底部添加脸书和/或推特社交按钮，请在中设置facebookAppId和/或推特站点配置选项siteConfig.js。

高级主题

我想在“只写博客”模式下运行。

您可以在没有登录页面的情况下运行Docusrus网站，但首先要加载博客。

去做这个:

1.在网站/静态/中创建index.html文件。

2.将以下模板的内容放入网站/静态/index.html。

3.自定义标题>的网站/静态/索引. html

4.删除动态登录页面网站/page/en/index . js。

现在，当Docusrus生成或构建您的网站时，它将从其中复制文件static/index.html，并将其放在网站的主目录中。当访问者到达您的页面时，会提供静态文件。页面加载后，访问者将被重定向到/blog。

您可以使用以下模板: