好的,我将为您整理并修复文档格式,输出标准的 Markdown 文档。
markdown Copy Code
文档部署指南
Node.js 环境部署
最新版本下载
Node.js 最新版本可从官方地址获取:https://nodejs.org/dist/v22.22.0/
安装步骤
Linux x64 系统
# 创建安装目录
mkdir -p /usr/local/node
# 下载并解压 Node.js
wget https://nodejs.org/dist/v22.22.0/node-v22.22.0-linux-x64.tar.gz
tar -zxvf node-v22.22.0-linux-x64.tar.gz
mkdir -p /usr/local/node
mv node-v22.22.0-linux-x64 /usr/local/node/
# 创建软链接
ln -sf /usr/local/node/node-v22.22.0-linux-x64/bin/node /usr/bin/node
ln -sf /usr/local/node/node-v22.22.0-linux-x64/bin/npm /usr/bin/npm
Linux ARM 64 系统
# 创建安装目录
mkdir -p /usr/local/node
# 下载并解压 Node.js
wget https://nodejs.org/dist/v22.22.0/node-v22.22.0-linux-arm64.tar.gz
tar -zxvf node-v22.22.0-linux-arm64.tar.gz
mv node-v22.22.0-linux-arm64 /usr/local/node/
# 创建软链接
ln -sf /usr/local/node/node-v22.22.0-linux-arm64/bin/node /usr/bin/node
ln -sf /usr/local/node/node-v22.22.0-linux-arm64/bin/npm /usr/bin/npm
fanconn_wiki 文档系统搭建
生成项目
直接执行以下命令生成项目目录:
cd /www
# 使用 Docusaurus 创建文档项目
npx create-docusaurus@latest fanconn_wiki classic --javascript
# 可选参数说明:
# --javascript:使用 JavaScript 版本(默认)
# --typescript:使用 TypeScript 版本
环境依赖安装
# 进入项目目录
cd /www/fanconn_wiki
# 安装项目依赖
npm install
常见问题处理
npm 版本更新
如果安装过程中提示 npm 版本需要更新,可执行以下命令:
# 更新 npm 到指定版本
npm install -g npm@11.4.2
注意: 更新 npm 版本前,请确认新版本与当前 Node.js 版本的兼容性。
安装完成后,可通过以下命令验证环境:
# 检查 Node.js 版本
node --version
# 检查 npm 版本
npm --version
# 启动开发服务器(在项目目录中执行)
npm start
使用说明
项目结构:安装完成后,/www/fanconn_wiki 目录下将包含完整的 Docusaurus 项目结构
内容编辑:文档内容位于 docs 目录中,支持 Markdown 格式
自定义配置:可通过修改 docusaurus.config.js 文件进行站点配置
构建部署:使用 npm run build 构建静态文件,部署到 Web 服务器
同步内容: mysyncrun_delete ../fanconn/docs/01.Industry-Solution-Boards/ 12:/www/fanconn/docs/01.Industry-Solution-Boards/
告示框
Docusaurus 的告示框 (Admonitions) 功能除了 :::note 外,总共支持 5 种官方内置类型。
以下是这些类型的标签、渲染效果和适用场景的汇总:
| 标签 | 渲染效果 | 主要适用场景 |
|---|---|---|
:::note | 备注 | 提供补充说明或上下文信息。 |
:::tip | 提示 | 提供小技巧或最佳实践。 |
:::info | 信息 | 提供一般性的事实或信息。 |
:::warning | 注意 | 提醒用户注意潜在问题。 |
:::danger | 危险 | 警示用户高风险或破坏性操作。 |
自定义和扩展
值得一提的是,告示框的结构非常灵活:
- 自定义标题:你可以使用
:::[type][Custom Title]的语法来覆盖默认的标题。例如,:::danger[重要安全提示]会将默认的“危险”标题改为“重要安全提示”。 - 内容支持Markdown和MDX:告示框内同样支持 Markdown 语法和 MDX 组件,可以用来放置链接、列表,甚至是交互式组件。
- 支持嵌套:你可以通过在
:::后增加:的数量(如::::)来实现告示框的嵌套。 - 使用JSX组件:在编写 React 页面时,也可以直接导入
<Admonition />组件来使用。 - 自定义类型:如果内置的5种类型不足以满足需求,你还可以通过代码来定义新的告示框类型,进行深度定制。
你提到的 info 标签,就是 Docusaurus 官方内置的 5 种类型之一,用于提供一般性的信息提示。
你大概想在什么场景下用到告示框呢?告诉我具体需要提示的内容,我看看哪种类型最合适~