This is an automated email from the ASF dual-hosted git repository. liujun pushed a commit to branch mkdocs in repository https://gitbox.apache.org/repos/asf/dubbo-website.git
commit 49285e8ec869e653475dc41e979fc52b1b996db1 Author: ken.lj <[email protected]> AuthorDate: Fri Oct 23 11:10:21 2020 +0800 update readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93092e1..00cd610 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,18 @@ Dubbo website is powered by [Mkdocs-material](https://github.com/squidfunk/mkdoc 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. -## Build instruction +## Develop instruction + +### Write docs or blogs + +1. Write docs or blog into standard Markdown files. +2. Add files into the directory you want to publish. +3. Update nav menus in `mkdocs_en.yml` and `mkdocs_zh.yml` accordingly. + +> Frequently used target directories are `en-us/docs`, `en-us/blogs`, `zh-cn/docs` and `zh-cn/blogs` + +### Build + 1. Install Mkdocs Check [here](https://www.mkdocs.org/) for details of how to install Mkdocs.
