该项目保留了用于构建 Nacos官方网站的所有资源,该网站服务于http://nacos.io。
- 在
npm i
根目录中运行以安装依赖项。 - 在根目录下运行
npm run dev
启动本地服务器,您将在“http://localhost:4321/”中看到网站。 - 运行
npm run build
以构建源代码。
Node.js 版本 >= 18.14.1
在 Astro + Starlight 项目中,您将看到以下文件夹和文件:
├── public/ # 静态资源
│ ├── font/
│ ├── img/
├── src/ # 源代码目录
│ ├── assets/
│ ├── components/ # 公共组件
│ │ ├── cloud/
│ │ ├── common/ # 通用组件
│ │ ├── contributors/
│ │ ├── home/ # 首页组件
│ │ ├── icon/
│ │ ├── markdownSet/
│ │ ├── starlight/
│ ├── content/
│ │ ├── blog/ # 博客目录
│ │ ├── docs/ # 文档目录
│ │ ├── download/ # 下载目录
│ │ └── config.ts
│ ├── helpers/
│ ├── i18n/ # 国际化词条配置
│ │ └── en/
│ │ └── zh-cn/
│ ├── layouts/ # 项目基础布局
│ ├── pages/
│ ├── style/
│ └── consts.ts # 项目常量管理
│ └── env.d.ts
│ └── util.ts # 通用工具函数
├── template/ # 404等通用页面模板
├── astro.config.mjs # Astro 配置文件
├── package.json
├── tailwind.config.json #tailwindcss配置文件
├── themeColor.json
└── tsconfig.json
Starlight 在目录中查找.md
或.mdx
文件 src/content/docs/
。每个文件都根据其文件名公开为路由。
src/assets/
可以通过相对链接将图像添加到Markdown 并嵌入到 Markdown 中。
静态资源(如网站图标)可以放置在该 public/
目录中。
- 首先创建一个问题来描述问题
- 不要用于
git add .
提交所有更改。 - 只需推送更改的文件,例如:
*.md
- _sidebar.json
- 向
master
分支发送 PR。
确保每个 .md 以以下文本开头:
---
title: title
keywords: [keywords1,keywords2,keywords3]
description: some description
sidebar:
order: Article table of contents order(optional)
---
参考这篇博客
注意:
- 'title'不能包含':'
- 'keywords' 必须是 'Array'
- 在
docs/en
或docs/zh-cn
下添加新的.md
文件。 - 更新
_sidebar.json
,在 en 或 zh-cn 博客中添加新目录。 - 推送拉取请求仅包含
.md
和_sidebar.json
。
查看 Starlight的文档, 阅读 Astro文档 ,或跳转到 Astro Discord 服务器.