好用的开源文档收集

一、文档

Docusaurus

Facebook | Docusaurus 2.0

Docusaurus会帮助你在极短的时间内搭建一个漂亮的文档网站。

💸 自己造轮子是一件苦差事。 现在，你可以专注于内容创作，只需编写 Markdown 文件即可。

💥 想深入了解吗？ 来试试包括文档分版、国际化、自定义搜索、个性化主题在内的进阶功能特性吧！

💅 看看优秀的Docusaurus网站 来获得灵感，并读读一些其他人的使用感言吧 。

🧐 Docusaurus 是一款静态站点生成器。 我们释放了React的全部潜能，搭建了这一款有着快速客户端导航与交互性极佳的单页应用。 它提供了开箱即用的文档功能，不过也可用于搭建各种网站（个人网站、产品、博客、营销主页，等等）。

设计原则

• 易学。 Docusaurus 的 API 小而精，保证易于上手使用。 用户仍然可以完成大多数功能，即使需要花更多时间写更多代码。 没有抽象要比错误的抽象更好，我们不希望用户在错误的抽象上捣鼓解决方案。 必修课——最小化的 API 表面积。
  • 直观。 用户查看 Docusaurus 项目目录或添加新特性时不会感到头昏脑胀。 软件应简单直观，用户则可轻松扩展。
• 客户端架构。 软件栈的分层（内容/主题/样式）应一目了然——充分抽象且模块化。
• 合理的默认设置。 常见、热门的性能优化选项会自动支持，并仍提供手动覆盖的方式。
• 不受约束。 用户无需使用默认插件或 CSS（虽然我们强烈推荐这么做）。 某些核心基础设施，例如 React Loadable 和 - - React Router 不能替换，因为我们基于这些做了默认性能优化，但更高层的架构则可以随意替换。 Markdown 引擎、CSS 框架、CSS 方法和其他架构的选择完全取决于用户。

我们相信，开发者足够了解一个应用库的运行原理，才能够更好地使用它。 因此，我们愿意花费精力来阐释 Docusaurus 的架构和各个组成部分，希望读者们可以拥有对它更深的理解，从而更熟练地使用它。

与其他工具 {#comparison-with-other-tools} 比较

在所有的静态网站生成器中，Docusaurus 独树一帜，专注于文档网站，拥有诸多开箱即用的功能。

我们同时也研究了其他一些主流静态站点生成器，想和你一起分享我们比较后的看法，希望能帮你在多种选择中做出判断。
Docusaurus
Gatsby
Next.js
VuePress
MkDocs
Docsify
GitBook
Jekyll

Vuepress

Vuepress

Docusaurus安装

安装nodejs

# Node.js >=16.14

# nodejs 版本
# https://nodejs.org/zh-cn/download/releases

# 根据docu版本要求，nodejs必须大于 16.14版本
    •   Node.js v18.16.0 to /usr/local/bin/node
    •   npm v9.5.1 to /usr/local/bin/npm
Make sure that /usr/local/bin is in your $PATH.

安装

cd ~
mkdir -p doc/docusa
cd doc/docusa

# 配置国内npm源
(base) ➜  npm config set registry http://registry.npm.taobao.org

(base) ➜   docusa npx create-docusaurus@latest my-website classic 

安装成功：

added 1100 packages in 28s
[SUCCESS] Created my-website.
[INFO] Inside that directory, you can run several commands:

  `npm start`
    Starts the development server.

  `npm run build`
    Bundles your website into static files for production.

  `npm run serve`
    Serves the built website locally.

  `npm deploy`
    Publishes the website to GitHub pages.

We recommend that you begin by typing:

  `cd my-website`
  `npm start`

Happy building awesome websites!

运行网站：

cd my-website
npx docusaurus start

安装完之后，访问：
http://localhost:3000/

查看目录：

(base) ➜  my-website ls -l
total 968
-rw-r--r--    1 kaiyi  staff     770 May  7 09:51 README.md
-rw-r--r--    1 kaiyi  staff      89 May  7 09:51 babel.config.js
drwxr-xr-x    7 kaiyi  staff     224 May  7 09:51 blog
drwxr-xr-x    5 kaiyi  staff     160 May  7 09:51 docs
-rw-r--r--    1 kaiyi  staff    4031 May  7 09:51 docusaurus.config.js
drwxr-xr-x  691 kaiyi  staff   22112 May  7 09:52 node_modules
-rw-r--r--    1 kaiyi  staff  472183 May  7 09:52 package-lock.json
-rw-r--r--    1 kaiyi  staff    1029 May  7 09:51 package.json
-rw-r--r--    1 kaiyi  staff     781 May  7 09:51 sidebars.js
drwxr-xr-x    5 kaiyi  staff     160 May  7 09:51 src
drwxr-xr-x    4 kaiyi  staff     128 May  7 09:51 static

相关文章：
Docusaurus
Docusaurus快速安装

为者常成，行者常至