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
The following commit(s) were added to refs/heads/mkdocs by this push:
new 076e239 update README.md
076e239 is described below
commit 076e2395d711167ea6d94b1b41c1ed747d406925
Author: ken.lj <[email protected]>
AuthorDate: Fri Oct 23 10:59:32 2020 +0800
update README.md
---
README.md | 39 ++++++++++++---------------------------
1 file changed, 12 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index a28b7eb..51a5af3 100644
--- a/README.md
+++ b/README.md
@@ -4,23 +4,27 @@
This project keeps all sources used for building up dubbo official website
which's served at https://dubbo.apache.org.
-
## Prerequisite
-Dubbo website is powered by [docsite](https://github.com/txd-team/docsite).
-If your version of docsite is less than `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.
+Dubbo website is powered by
[Mkdocs-material](https://github.com/squidfunk/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.
## Build instruction
+1. Install Mkdocs
+Check [here](https://www.mkdocs.org/) 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.
+2. 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](https://www.mkdocs.org/)
command for how to test changes quickly and on the fly.
## How to send a PR
-
-1. Do not use `git add .` to commit all the changes.
-2. Just push your changed files, such as:
+1. Just push your changed files, such as:
* `*.md`
* blog.js or docs.js or site.js
-3. Send a PR to **master** branch.
+2. Send a PR to **master** branch.
## SEO
@@ -35,22 +39,3 @@ description: some description
```
Refer to [this blog](blog/zh-cn/how-to-involve-dubbo-community.md)
-
-
-## Guide for adding new document
-
-### Add a new blog
-
-1. Add new .md file under blog/en-us or blog/zh-cn.
-2. Update site_config/blog.js, add a new entry to the blog in either en-us or
zh-cn.
-3. Run docsite start locally to verify the blog can be displayed correctly.
-4. Send the pull request contains the .md and blog.js only.
-
-
-### Add a new article for developers
-
-1. 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.
-2. Update site_config/develop.js, add a new entry in either en-us or zh-cn.
-3. Run docsite start locally to verify the article can be displayed correctly.
-4. Send the pull request contains the *_dev.md and develop.js only.
-
