docs(Docs): add 安装&项目结构 page
This commit is contained in:
parent
8d6ed1b52c
commit
28a950478b
@ -74,7 +74,14 @@ export default defineUserConfig({
|
|||||||
// title: true, // 是否生成标题
|
// title: true, // 是否生成标题
|
||||||
// },
|
// },
|
||||||
|
|
||||||
|
// 文章贡献者
|
||||||
|
contributors: {
|
||||||
|
mode: 'block',
|
||||||
|
},
|
||||||
|
|
||||||
plugins: {
|
plugins: {
|
||||||
|
git: true,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Shiki 代码高亮
|
* Shiki 代码高亮
|
||||||
* @see https://theme-plume.vuejs.press/config/plugins/code-highlight/
|
* @see https://theme-plume.vuejs.press/config/plugins/code-highlight/
|
||||||
|
|||||||
@ -5,7 +5,7 @@ export const navbar = defineNavbarConfig([
|
|||||||
{
|
{
|
||||||
text: '指南',
|
text: '指南',
|
||||||
icon: 'icon-park-outline:guide-board',
|
icon: 'icon-park-outline:guide-board',
|
||||||
link: '/notes/guide/介绍.md',
|
link: '/notes/guide/quick-start/介绍.md',
|
||||||
},
|
},
|
||||||
{ text: 'SDK', link: '/notes/sdk/README.md', icon: 'carbon:api' },
|
{ text: 'SDK', link: '/notes/sdk/README.md', icon: 'carbon:api' },
|
||||||
{ text: '推广中心', link: '/notes/promotion/README.md', icon: 'mdi:star-shooting-outline' },
|
{ text: '推广中心', link: '/notes/promotion/README.md', icon: 'mdi:star-shooting-outline' },
|
||||||
|
|||||||
@ -63,9 +63,12 @@ const guideNote = defineNoteConfig({
|
|||||||
{
|
{
|
||||||
text: '快速入门',
|
text: '快速入门',
|
||||||
collapsed: false,
|
collapsed: false,
|
||||||
|
prefix: 'quick-start',
|
||||||
icon: 'carbon:lightning',
|
icon: 'carbon:lightning',
|
||||||
items: [
|
items: [
|
||||||
'介绍',
|
'介绍',
|
||||||
|
'安装',
|
||||||
|
'项目结构',
|
||||||
'部署'
|
'部署'
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
@ -118,12 +118,4 @@ import RepoCard from 'vuepress-theme-plume/features/RepoCard.vue'
|
|||||||
pnpm run editor:dev
|
pnpm run editor:dev
|
||||||
```
|
```
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
##### Tips:
|
|
||||||
|
|
||||||
- `Node >= 23.0.0`;
|
|
||||||
|
|
||||||
### 更新记录
|
|
||||||
|
|
||||||
[Changelog](/notes/update/logs/)
|
|
||||||
84
packages/docs/src/notes/guide/quick-start/安装.md
Normal file
84
packages/docs/src/notes/guide/quick-start/安装.md
Normal file
@ -0,0 +1,84 @@
|
|||||||
|
---
|
||||||
|
title: 安装/使用
|
||||||
|
createTime: 2025/10/06 21:35:36
|
||||||
|
permalink: /guide/p8awar6v/
|
||||||
|
---
|
||||||
|
|
||||||
|
[+node-versions]: **>= 23.0.0:** `23.0.0` 及以上的版本
|
||||||
|
[+pnpm-versions]: **>= 10.0.0:** `10.0.0` 及以上的版本
|
||||||
|
[+corepack]: 从 **v16.13** 开始,`Node.js` 附带 `Corepack` 用于管理包管理器
|
||||||
|
|
||||||
|
|
||||||
|
## 依赖环境
|
||||||
|
|
||||||
|
- [Node.js](https://nodejs.org/) : **>= 23.0.0** [+node-versions]
|
||||||
|
- [pnpm](https://pnpm.io/zh/) : **>= 10.0.0** [+pnpm-versions]
|
||||||
|
|
||||||
|
:::: details 怎么安装依赖环境?
|
||||||
|
::: steps
|
||||||
|
|
||||||
|
1. **请前往 [Node.js 官网](https://nodejs.org/zh-cn) 下载最新稳定版本**
|
||||||
|
|
||||||
|
请根据指引完成安装,一般而言,在安装过程中,您只需要保持其默认设置,直接选择下一步即可。
|
||||||
|
|
||||||
|
2. **安装 PNPM**
|
||||||
|
|
||||||
|
|
||||||
|
在您安装完成 node.js 后,请打开 终端,执行如下命令:[+corepack]
|
||||||
|
|
||||||
|
```sh
|
||||||
|
corepack enable pnpm
|
||||||
|
|
||||||
|
# [optional]
|
||||||
|
# 这会添加一个 packageManager 字段到你本地的 package.json,
|
||||||
|
# 指示 Corepack 始终在该项目上使用特定的版本。
|
||||||
|
# 如果你想要可复现性,这可能很有用,因为所有使用 Corepack 的开发人员都将使用与你相同的版本
|
||||||
|
corepack use pnpm@latest-10
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **完成**
|
||||||
|
|
||||||
|
:::
|
||||||
|
::::
|
||||||
|
|
||||||
|
## 安装
|
||||||
|
|
||||||
|
:::: steps
|
||||||
|
|
||||||
|
- ### Git拉取项目
|
||||||
|
``` sh
|
||||||
|
git clone https://github.com/mlt131220/Astral3D.git
|
||||||
|
```
|
||||||
|
|
||||||
|
- ### 进入目录
|
||||||
|
``` sh
|
||||||
|
cd Astral3D
|
||||||
|
```
|
||||||
|
|
||||||
|
- ### 安装相关依赖
|
||||||
|
::: code-tabs
|
||||||
|
@tab pnpm
|
||||||
|
``` sh
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
:::
|
||||||
|
|
||||||
|
- ### 构建SDK
|
||||||
|
::: code-tabs
|
||||||
|
@tab pnpm
|
||||||
|
``` sh
|
||||||
|
pnpm run sdk:build
|
||||||
|
```
|
||||||
|
:::
|
||||||
|
|
||||||
|
- ### 运行编辑器
|
||||||
|
::: code-tabs
|
||||||
|
@tab pnpm
|
||||||
|
``` sh
|
||||||
|
pnpm run editor:dev
|
||||||
|
```
|
||||||
|
:::
|
||||||
|
|
||||||
|
- ### 完成
|
||||||
|
|
||||||
|
::::
|
||||||
31
packages/docs/src/notes/guide/quick-start/项目结构.md
Normal file
31
packages/docs/src/notes/guide/quick-start/项目结构.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
title: 项目结构(更新中)
|
||||||
|
createTime: 2025/10/06 22:08:28
|
||||||
|
permalink: /guide/zdiy72f2/
|
||||||
|
---
|
||||||
|
|
||||||
|
本指南将向您说明 `Astral 3D` 项目的文件结构。
|
||||||
|
|
||||||
|
`Astral 3D`代码是以`Monorepo`的方式管理的,它的文件结构是这样的:
|
||||||
|
|
||||||
|
::: file-tree
|
||||||
|
|
||||||
|
- .git/
|
||||||
|
- .idea/
|
||||||
|
- common \# 通用代码包
|
||||||
|
- build/ \# vite构建相关
|
||||||
|
- packages \# 主项目包
|
||||||
|
- docs/ \# Astral 3D 文档
|
||||||
|
- **editor/** \# Astral 3D 编辑器
|
||||||
|
- **sdk/** \# Astral 3D 引擎
|
||||||
|
- .gitignore
|
||||||
|
- .npmrc
|
||||||
|
- CONTRIBUTING.md
|
||||||
|
- LEGAL.md
|
||||||
|
- LICENSE
|
||||||
|
- package.json
|
||||||
|
- pnpm-lock.yaml
|
||||||
|
- pnpm-workspace.yaml
|
||||||
|
- README.en.md
|
||||||
|
- README.md
|
||||||
|
:::
|
||||||
Loading…
Reference in New Issue
Block a user