Dubbo Official Website
Dubbo website is powered by docsite.
If your version of docsite is less than
1.3.3, please upgrade to
Please also make sure your node version is 8.x, versions higher than 8.x is not supported by docsite yet.
npm install docsite -gto install the dev tool.
npm iin the root directory to install the dependencies.
docsite startin the root directory to start a local server, you will see the website in 'http://127.0.0.1:8080'.
docsite buildto build source code.
- Verify your change locally:
python -m SimpleHTTPServer 8000, when your python version is 3 use :
python3 -m http.server 8000instead.
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
nvm install v8.16.0to install node v8
nvm use v8.16.0to switch the working environment to node v8
npm install docsite -g
Then you are all set to run and build the website. Follow the build instruction above for the details.
How to send a PR
- Do not use
git add .to commit all the changes.
- Just push your changed files, such as:
- blog.js or docs.js or site.js
- Send a PR to master branch.
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.
Add a new article for developers
- Add new .md file under docs/en-us/developers or docs/zh-cn/developers, the file name should end up with _dev.md. Note that the suffix _dev is necessary.
- Update site_config/develop.js, add a new entry in either en-us or zh-cn.
- Run docsite start locally to verify the article can be displayed correctly.
- Send the pull request contains the *_dev.md and develop.js only.