Nacos Official WebSite

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

Prerequisite

Nacos website is powered by docsite. If your version of docsite is less then 1.3.3, please upgrade to 1.3.3. Please also make sure your node version is 8.x, versions higher than 8.x is not supported by docsite yet.

If you have already a npm with another version installed, run the folling two commands to change the version to 8.x:

npm install -g n
sudo n 8.0

Build instruction

Run npm install docsite@1.3.3 -g to install the dev tool.
Run npm i in the root directory to install the dependencies.
Run docsite start in the root directory to start a local server, you will see the website in 'http://127.0.0.1:8080'.
Run docsite build to build source code.
Verify your change locally: python -m SimpleHTTPServer 8000, when your python version is 3 use :python3 -m http.server 8000 instead.

If you have higher version of node installed, you may consider nvm to allow different versions of node coexisting on your machine.

Follow the instructions to install nvm
Run nvm install v8.16.0 to install node v8
Run nvm use v8.16.0 to switch the working environment to node v8
Run npm install docsite -g

How to Contribute

Create an issue first to description the issue
Do not use git add . to commit all the changes.
Just push your changed files, such as:
- *.md
- blog.js or docs.js or site.js
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
---

Refer to this blog

Guide for adding new document

Add a new blog

Add new .md file under blog/en-us or blog/zh-cn.
Update site_config/blog.js, add a new entry to the blog in either en-us or zh-cn.
Run docsite start locally to verify the blog can be displayed correctly.
Send the pull request contains the .md and blog.js only.