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優化	構成用於最佳搜索引擎索引的結構。

其他主題