Skip to content

Commit

Permalink
fixed:readme优化
Browse files Browse the repository at this point in the history
  • Loading branch information
Tinie13 committed Jan 23, 2024
1 parent 2019fce commit c2ec277
Showing 1 changed file with 54 additions and 1 deletion.
55 changes: 54 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Starlight Starter Kit: Basics
# Nacos Official WebSite
All website material of https://nacos.io.


## Starlight Starter Kit: Basics

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

Expand All @@ -12,6 +16,19 @@ npm create astro@latest -- --template starlight

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## Quick Start

1. `npm install`

2. `npm run dev`

3. Visit
```
localhost:4321/
```

## Requirements
Node.js version >=18.14.1
## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:
Expand Down Expand Up @@ -49,6 +66,42 @@ All commands are run from the root of the project, from a terminal:
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |

## 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
sidebar:
order: Article table of contents order(optional)
---
```

Refer to [this blog](src/content/docs/latest/what-is-nacos)
**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-us 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).

0 comments on commit c2ec277

Please sign in to comment.