Skip to content

Latest commit

 

History

History
107 lines (81 loc) · 3.27 KB

README.zh_CN.md

File metadata and controls

107 lines (81 loc) · 3.27 KB

Nacos 官方网站

该项目保留了用于构建 Nacos官方网站的所有资源,该网站服务于http://nacos.io。

README.md同时有以下语言的版本

构建指令

  1. npm i 根目录中运行以安装依赖项。
  2. 在根目录下运行 npm run dev 启动本地服务器,您将在“http://localhost:4321/”中看到网站。
  3. 运行 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/目录中。

如何贡献

  1. 首先创建一个问题来描述问题
  2. 不要用于git add .提交所有更改。
  3. 只需推送更改的文件,例如:
    • *.md
    • _sidebar.json
  4. master分支发送 PR。

搜索引擎优化(SEO)

确保每个 .md 以以下文本开头:

---
title: title
keywords: [keywords1,keywords2,keywords3]
description: some description
sidebar:
    order: Article table of contents order(optional)
---

参考这篇博客

注意:

  1. 'title'不能包含':'
  2. 'keywords' 必须是 'Array'

添加新文档指南

添加新文档

  1. docs/endocs/zh-cn下添加新的 .md 文件。
  2. 更新 _sidebar.json ,在 en 或 zh-cn 博客中添加新目录。
  3. 推送拉取请求仅包含 .md_sidebar.json

👀 想了解更多吗?

查看 Starlight的文档, 阅读 Astro文档 ,或跳转到 Astro Discord 服务器.