https://github.com/nacos-group/nacos-group.github.io
nacos-group.github.io
https://github.com/nacos-group/nacos-group.github.io
dubbo istio kubernetes nacos nacos-sync springcloud
Last synced: about 3 hours ago
JSON representation
nacos-group.github.io
- Host: GitHub
- URL: https://github.com/nacos-group/nacos-group.github.io
- Owner: nacos-group
- License: apache-2.0
- Created: 2018-07-20T08:34:10.000Z (about 7 years ago)
- Default Branch: develop-astro-nacos
- Last Pushed: 2025-09-23T08:26:49.000Z (14 days ago)
- Last Synced: 2025-09-23T10:04:25.042Z (14 days ago)
- Topics: dubbo, istio, kubernetes, nacos, nacos-sync, springcloud
- Language: MDX
- Size: 1.25 GB
- Stars: 109
- Watchers: 38
- Forks: 191
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nacos Official WebSite
This project keeps all sources used for building up [Nacos](https://github.com/alibaba/nacos) official website which's served at http://nacos.io.
# README.md
- en [English](README.md)
- zh_CN [็ฎไฝไธญๆ](README.zh_CN.md)
## Build instruction
1. Run `npm i` in the root directory to install the dependencies.
2. Run `npm run dev` in the root directory to start a local server, you will see the website in `localhost:4321`.
3. Run `npm run build` to build source code.
## Requirements
Node.js version >= 18.14.1
## ๐ Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
```
โโโ public/ # Static Assest
โ โโโ font/
โ โโโ img/
โโโ src/ # Source Directory
โ โโโ assets/
โ โโโ components/ # Common Components
โ โ โโโ cloud/
โ โ โโโ common/ # General Components
โ โ โโโ contributors/
โ โ โโโ home/ # Homepage Components
โ โ โโโ icon/
โ โ โโโ markdownSet/
โ โ โโโ starlight/
โ โโโ content/
โ โ โโโ blog/ # Blog Directory
โ โ โโโ docs/ # Docs Directory
โ โ โโโ download/ # Download Directory
โ โ โโโ config.ts
โ โโโ helpers/
โ โโโ i18n/ # International entry configuration
โ โ โโโ en/
โ โ โโโ zh-cn/
โ โโโ layouts/ # Basic layout of the project
โ โโโ pages/
โ โโโ style/
โ โโโ consts.ts # Project Constant Management
โ โโโ env.d.ts
โ โโโ util.ts # General utility functions
โโโ template/ # 404 and other universal page templates
โโโ astro.config.mjs # Astro profile
โโโ package.json
โโโ tailwind.config.json # tailwindcss profile
โโโ themeColor.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
2. Do not use `git add .` to commit all the changes.
3. Just push your changed files, such as:
* `*.md`
* _sidebar.json
4. Send a PR to `master` branch.
## SEO
Make sure each .md starts with the following texts:
```
---
title: title
keywords: [keywords1,keywords2,keywords3]
description: some description(less than 160 words)
sidebar:
order: Article table of contents order(optional)
---
```
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`
## Guide for adding new document
### Add a new doc
1. Add new .md file under `docs/en` or `docs/zh-cn`.
2. Update `_sidebar.json`, add a new entry to the blog in either en or zh-cn.
3. Send the pull request contains the `.md` and `_sidebar.json` only.
## ๐ Want to learn more?
Check out [Starlightโs docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).