Skip to content

Commit

Permalink
fixed:add Project Structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Tinie13 committed Jan 24, 2024
1 parent aff5274 commit 3bc821b
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,30 @@ This project keeps all sources used for building up [Nacos](https://github.com/a

Node.js version >= 18.14.1

## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```

Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## How to Contribute

1. Create an issue first to description the issue
Expand All @@ -40,7 +64,7 @@ sidebar:
---
```

Refer to [this blog](src/content/docs/latest/what-is-nacos)
Refer to [this blog](src/content/docs/latest/en/what-is-nacos.md)
**Note:**
1. `title` can not include `:`
2. `keywords` must be a `Array`
Expand Down
26 changes: 25 additions & 1 deletion README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,30 @@

Node.js 版本 >= 18.14.1

## 🚀 项目结构

在 Astro + Starlight 项目中,您将看到以下文件夹和文件:

```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```

Starlight 在目录中查找`.md``.mdx`文件 `src/content/docs/`。每个文件都根据其文件名公开为路由。

`src/assets/`可以通过相对链接将图像添加到Markdown 并嵌入到 Markdown 中。

静态资源(如网站图标)可以放置在该 `public/`目录中。

## 如何贡献

1. 首先创建一个问题来描述问题
Expand All @@ -40,7 +64,7 @@ sidebar:
---
```

参考[这篇博客](src/content/docs/latest/en/what-is-nacos)
参考[这篇博客](src/content/docs/latest/zh-cn/what-is-nacos.md)

**注意:**
1. 'title'不能包含':'
Expand Down

0 comments on commit 3bc821b

Please sign in to comment.