This project keeps all sources used for building up Dubbo official website which's served at https://dubbo.apache.org.
Dubbo website is powered by Mkdocs-material.
If your version of Mkdocs is less than 1.1.2, please upgrade to 1.1.2.
Please also make sure you have proper python version installed locally.
- Write docs or blog into standard Markdown files.
- Add files into the directory you want to publish.
- Update nav menus in
mkdocs_en.ymlandmkdocs_zh.ymlaccordingly.
Frequently used target directories are
en-us/docs,en-us/blogs,zh-cn/docsandzh-cn/blogs
- Install Mkdocs
Check here for details of how to install Mkdocs.
As we have mkdocs-material source codes embedded inside our website, installation of Mkdocs-material is not required.
- Build the site
Run mkdocs build --config-file=mkdocs_en.yml or mkdocs build --config-file=mkdocs_zh.yml to build .md files into static files.
Building is only needed when you want to check the effects of your changes locally, you do not need to build before commit, commit the .md source files directly. Check serve command for how to test changes quickly and on the fly.
- Push your changed files and 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