You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dubbo.apache.org by li...@apache.org on 2023/01/25 10:40:47 UTC
[dubbo-website] 03/03: update README.md
This is an automated email from the ASF dual-hosted git repository.
liujun pushed a commit to branch refactor/next
in repository https://gitbox.apache.org/repos/asf/dubbo-website.git
commit d22333ebf946f74e8b3178554decd8613c4937bf
Author: chickenlj <ke...@gmail.com>
AuthorDate: Wed Jan 25 18:37:45 2023 +0800
update README.md
---
README.md | 41 +++++++++--------------------------------
1 file changed, 9 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
index 2bd6b26808..6b35ea4075 100644
--- a/README.md
+++ b/README.md
@@ -7,58 +7,35 @@ This project keeps all sources used for building up Dubbo official website which
## Overview
The Apache Dubbo docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme.
-This project contains the hugo project, markdown files, and theme configurations.
+
+This project contains the markdown source files of the Dubbo documentation.
## Pre-requisites
- [Hugo extended version](https://gohugo.io/getting-started/installing)
+- [Go](https://go.dev/learn/)
- [Node.js](https://nodejs.org/en/)
## Environment setup
-
-You can directly start working on this repository even from your browser by just clicking on the following button
-
-[](https://gitpod.io/#https://github.com/apache/dubbo-website)
-
-Or, you can follow the manual steps given below.
-
1. Ensure pre-requisites are installed
2. Clone this repository
```sh
git clone https://github.com/apache/dubbo-website.git
```
-3. Change to root directory:
-```sh
-cd dubbo-website
-```
-4. Add Docsy submodule:
-```sh
-git submodule add https://github.com/google/docsy.git themes/docsy
-```
-5. Update submodules:
-```sh
-git submodule update --init --recursive
-```
+3. Install `PostCSS` required by Docsy by running the following commands from the root directory of your project:
-6. Install npm packages:
```sh
-npm install
+$ npm install --save-dev autoprefixer
+$ npm install -D postcss
+$ npm install --save-dev postcss-cli
```
-## Run local server
-1. Run
+## Run server locally
+1. Run
```sh
hugo server --disableFastRender
```
-> Troubleshooting. If you run into error like `fatal error: pipe failed` on MacOS, try the following command first:
-> ```sh
-> sudo launchctl limit maxfiles 65535 200000
-> ulimit -n 65535
-> sudo sysctl -w kern.maxfiles=100000
-> sudo sysctl -w kern.maxfilesperproc=65535
-> ```
-
2. Navigate to `http://localhost:1313`
## Update docs