Skip to content

Latest commit

 

History

History
106 lines (81 loc) · 3.39 KB

README.md

File metadata and controls

106 lines (81 loc) · 3.39 KB
Raw

Nacos Official WebSite

This project keeps all sources used for building up Nacos official website which's served at http://nacos.io.

README.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 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, read the Astro documentation, or jump into the Astro Discord server.