开发者手册
欢迎来到 开发者手册。
本网站致力于记录开发者所需的重要知识与最佳实践。
目的
本手册的目的是构建一个全面的开发者资源库，内容涵盖广泛，包括但不限于：
- 编程语言
- 框架与类库
- 开发工具
- 最佳实践
- 设计模式
- 以及更多内容……
欢迎使用 Docusaurus
欢迎使用 Docusaurus！本指南将帮助你快速了解如何下载代码、初始化项目、运行本地开发服务器，并对文档进行编辑与扩展。
🚀 快速开始
1. 克隆项目代码
git clone https://github.com/facebook/docusaurus.git
cd docusaurus
2. 安装依赖
npm install
# 或使用 yarn
# yarn install
3. 启动本地开发服务器
npm run start
📁 项目结构一览
my-website/
├── docs/ # 存放文档的 Markdown 文件
│ ├── intro.md
│ ├── getting-started.md
│ └── ...
├── src/ # 自定义页面和 React 组件
├── static/ # 静态资源文件夹（图片、PDF 等）
├── docusaurus.config.js # 主配置文件
├── sidebars.js # 侧边栏配置文件
├── package.json # 依赖包和命令配置
└── README.md # 项目说明文件
tip
几乎所有的文档都位于 docs/ 文件夹中，每个 .md 文件会自动成为一个页面。
📝 编辑与新增文档
编辑已有文档
只需打开 docs/ 目录下对应的 .md 文件并编辑，例如：
---
title: 项目介绍
sidebar_position: 1
---
# 项目介绍
这是我们的文档首页内容……
添加新文档
- 在
docs/目录中新增 Markdown 文件，例如hello.md - 更新
sidebars.js文件，加入新页面路径：
module.exports = {
tutorialSidebar: [
'intro',
'getting-started',
'hello', // 新增文档
],
};
点击展开：Frontmatter 示例
每个文档顶部应包含 Frontmatter，用于设置标题、排序等信息：
---
id: hello
title: 我的第一个文档
sidebar_position: 3
---
🧩 多语言代码片段示例
- JavaScript
- TypeScript
- Python
- JSX
console.log("Hello from Docusaurus!");
function greet(name: string): string {
return `Hello, ${name}`;
}
console.log(greet("Docusaurus"));
def greet(name):
return f"Hello, {name}"
print(greet("Docusaurus"))
export default function Hello() {
return <h1>Hello from Docusaurus!</h1>;
}
📦 构建与部署
npm run build
caution
构建命令会在 build/ 目录中生成静态 HTML 文件，可用于部署到 GitHub Pages、Vercel、Netlify 等平台。
📚 更多资源
祝你使用愉快！🚀✨