File tree 1 file changed +4
-17
lines changed
1 file changed +4
-17
lines changed Original file line number Diff line number Diff line change 4
4
5
5
This repository contains the assets required to build the [ Genji documentation] ( https://genji.dev ) .
6
6
7
- ## Prerequisites
7
+ The Genji website uses the [ Docsy Hugo theme ] ( https://github.com/google/docsy#readme ) installed as a Hugo module.
8
8
9
- To use this repository, you need the following installed locally:
9
+ ## Prerequisites
10
10
11
- - [ yarn] ( https://yarnpkg.com/ )
12
- - [ npm] ( https://www.npmjs.com/ )
13
- - [ Hugo] ( https://gohugo.io/ )
11
+ To use this repository, you need to install [ Hugo] ( https://gohugo.io/ ) .
14
12
15
- Before you start, install the dependencies. Clone the repository and navigate to the directory:
13
+ Clone the repository and navigate to the directory:
16
14
17
15
```
18
16
git clone https://github.com/genjidb/docs.git
19
17
cd docs
20
18
```
21
19
22
- The Genji website uses the [ Docsy Hugo theme] ( https://github.com/google/docsy#readme ) installed as a git submodule.
23
-
24
- ```
25
- # install dependencies
26
- yarn
27
-
28
- # pull in the Docsy submodule
29
- git submodule update --init --recursive --depth 1
30
- ```
31
-
32
20
## Running the website locally using Hugo
33
21
34
22
To build and test the site locally, run:
@@ -38,4 +26,3 @@ hugo serve
38
26
```
39
27
40
28
This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the website.
41
-
You can’t perform that action at this time.
0 commit comments