Aria Docs

Ariadocs-文档模板

此功能包装的文档模板由Next.js构建，提供了时尚且响应的设计，非常适合您所有项目文档需求。

以下是Ariadocs模板的所有版本，每个版本都为特定用例制作：

• 高级文档：一个全面的模板，为深入文档需求提供广泛的功能。非常适合需要详细说明和高级配置的大型项目。
  探索高级文档

• LITE版本：精简的，无弄清的模板非常适合简单的文档需求。
  探索Lite版本

• 具有版本控制的版本：一个需要历史文档跟踪的项目的强大选项。毫不费力地管理文档的多个版本。
  查看版本控制功能

• I18N支持版（WIP）：该版本专为国际观众而设计，将提供全面的多语言支持。
  预览I18N支持

快速开始

您可以使用命令来创建一个新的Ariadocs项目：

 npx create-aria-doc <project-directory>

预期输出

运行CLI时，您可以期望与此类似的输出：

 Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.
   npm install --force 
3. Start the development server:
   npm run dev

入门

首先，运行开发服务器：

 npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

部署在Vercel上

部署您的next.js应用的最简单方法是使用Next.js的创建者的Vercel平台。

请查看我们的Next.js部署文档以获取更多详细信息。

关键功能

特征	描述
MDX支持	用MDX编写交互式文档。
嵌套页	在嵌套的层次结构中组织内容。
博客部分	包括一个专用的博客部分。
目录	自动生成的TOC以方便导航。
分页	跨多个页面拆分内容。
语法突出显示	突出显示代码以提高可读性。
代码线突出显示和标题	突出显示具有描述性标题的特定行。
交互式代码块	特定于语言的交互式代码显示。
自定义组件	文档中嵌入自定义，可重复使用的组件。
浅色模式	在光和黑暗主题之间切换。
搜索功能	通过内置搜索快速找到内容。
代码切换器	在代码语言或变化之间切换。
代码副本	单击复制代码块。
TOC观察者突出显示	滚动时，突出显示TOC中的活动部分。
静态站点生成	生成一个静态的高性能站点。
Seo优化	构成用于最佳搜索引擎索引的结构。

其他主题