目录

简介

优质
小牛编辑
122浏览
2023-12-01

Docusaurus 是一个轻松构建,部署和维护开源项目的网站项目。

  • 快速起步 Docusaurus 的构建很容易,在尽可能短的时间内 开始并运行 。我们已经打造了 Docusaurus 来处理网站构建过程,以便您可以专注于您的项目。
  • 本地化 Docusaurus 通过 CrowdIn 提供 本地化支持。通过翻译文档来增强您的国际社区的地位。
  • 可定制 虽然 Docusaurus 带有您需要开始的关键页面和部分,包括主页,文档部分,博客和其他支持页面,但它也是可定制的,以确保您拥有一个独一无二的网站。

安装

Docusaurus 作为 npm 上的 docusaurus 来提供。

我们还发布了 docusaurus-init ,来使 Docusaurus 的 入门 更加简单。

最后更新:

类似资料

  • Docusaurus 帮你快速构建并优化网站,让你专注于创作内容,快速起步 Docusaurus 的构建很容易,在尽可能短的时间内 开始并运行 。

  • 支持 Markdown 节省时间,让你完全专注于项目文档。 你只须专注使用 Markdown/MDX 格式编写文档和文章即可,Docusaurus 会自动生成可以对外发布的静态 HTML 文件。 借助MDX,你甚至可以将 JSX 组件嵌入到 Markdown 中。 基于 React 技术构建 利用 React,你可以扩展或自定义项目的页面布局。 能够在重用相同的页眉和页脚的同时仍然被 扩展。 支持

  • 官方提供了 Docusaurus 主题。 基本主题 基本主题为 docs、blog 和 pages 插件实现了用户界面。 @docusaurus/theme-classic @docusaurus/theme-bootstrap caution 我们的目标是让所有主题共享完全相同的功能、用户体验和配置。 仅 UI 设计和底层的样式框架可以更改,并且主题要易于修改。 我们还没达到上述理想:目前仅有

  • Docusaurus 官方提供了一系列插件。 内容插件 这些插件负责加载网站的内容,并根据你的主题创建并渲染页面。 @docusaurus/plugin-content-docs @docusaurus/plugin-content-blog @docusaurus/plugin-content-pages 行为插件 这些插件将为你的 Docusaurus 网站添加有用的行为。 @docusaur

  • 概览 docusaurus.config.js 文件保存了站点的配置信息,此文件被放置于站点的根目录中。 必须字段 title 类型: string 网站的标题。docusaurus.config.js module.exports = { title: 'Docusaurus', }; favicon 类型: string 网站的 favicon 文件的 URL 链接。例如:docu

  • Docusaurus 提供了一组客户端 API,对于构建网站很有帮助。 组件 <Head/> 这是一个可重用 React 组件,用于管理对 HTML 文档标头(即 <head> 中的标签)的修改。此组件接收纯 HTML 标签并输出纯 HTML 标签,对初学者很友好。此组件始对 React Helmet 的二次包装。 用法示例: import React from 'react'; import

相关阅读

开发工具

Docusaurus