Skip to content

Commit ab7ab1b

Browse files
wangchengming666呈铭
and
呈铭
authored
update README.md (#251)
Co-authored-by: 呈铭 <[email protected]>
1 parent 8cf4a31 commit ab7ab1b

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

README.md

+46-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,51 @@ Source for mosn.io site <https://mosn.io>.
44

55
Powered by [hugo](https://gohugo.io) with [docsy theme](https://github.com/google/docsy).
66

7-
## Notice
7+
# Install Hugo
8+
9+
You need a [recent extended version](https://github.com/gohugoio/hugo/releases) (we recommend version 0.53 or later) of [Hugo](https://gohugo.io/) to do local builds and previews of sites (like this one) that use Docsy. If you install from the release page, make sure to get the `extended` Hugo version, which supports [SCSS](https://sass-lang.com/documentation/file.SCSS_FOR_SASS_USERS.html); you may need to scroll down the list of releases to see it.
10+
11+
For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/).
12+
13+
# Environment setup
14+
You can follow the manual steps given below.
15+
16+
1. Ensure pre-requisites are installed
17+
2. Clone this repository
18+
19+
```
20+
git clone [email protected]:mosn/mosn.io.git
21+
```
22+
23+
3. Install `PostCSS` required by Docsy by running the following commands from the root directory of your project:
24+
25+
```
26+
npm install --save-dev autoprefixer
27+
npm install -D postcss
28+
npm install --save-dev postcss-cli
29+
```
30+
31+
# Run server locally
32+
1. Clear up your local module cache
33+
34+
```
35+
hugo mod clean
36+
```
37+
38+
2. Start the server
39+
40+
```
41+
hugo server --disableFastRender
42+
```
43+
44+
3. Navigate to `http://localhost:1313`
45+
46+
# Update docs
47+
1. Create new branch
48+
2. Commit and push changes to content
49+
3. Submit pull request to master branch
50+
4. Staging site will automatically get created and linked to PR to review and test
51+
52+
# Notice
853

954
This website is built under hugo version v0.55.5-A83256B9C/extended. There may be unknown errors when compiling on other versions.

0 commit comments

Comments
 (0)