File tree 1 file changed +65
-1
lines changed
1 file changed +65
-1
lines changed Original file line number Diff line number Diff line change 1
- # Geekdoc
1
+ # CYBERTEC Geekdoc
2
+
3
+ A CYBERTEC themed fork of [ geekdoc] ( https://github.com/thegeeklab/hugo-geekdoc ) , a Hugo theme made for documentation.
4
+
5
+ ---
6
+
7
+ ## Requirements
8
+
9
+ - [ ` go ` ] ( https://go.dev/doc/install )
10
+ - [ ` hugo ` ] ( https://gohugo.io/installation/ )
11
+
12
+ ## Usage
13
+
14
+ Initialize a new hugo site:
15
+
16
+ ``` shell
17
+ hugo new site < site-name>
18
+ cd < site-name>
19
+ ```
20
+
21
+ Initialize the site as a go module:
22
+
23
+ ``` shell
24
+ hugo mod init github.com/cybertec-postgresql/< repository-name>
25
+ ```
26
+
27
+ Add the following to your ` hugo.toml ` to use this theme, including functional code-highlighting:
28
+
29
+ ``` toml
30
+ # hugo.toml
31
+ pygmentsCodeFences = true
32
+ pygmentsUseClasses = true
33
+
34
+ [module ]
35
+ [[module .imports ]]
36
+ path = ' github.com/cybertec-postgresql/hugo-geekdoc'
37
+ ```
38
+
39
+ Fetch the module
40
+
41
+ ``` shell
42
+ hugo mod get -u
43
+ ```
44
+
45
+ Build your page
46
+ ``` shell
47
+ hugo --minify
48
+ # You may optionally overwrite the `baseURL`
49
+ hugo --minify -b " /docs/"
50
+ ```
51
+
52
+ ## Update
53
+
54
+ To retrieve the latest version of this theme, simply run
55
+
56
+ ``` shell
57
+ hugo mod get -u
58
+ hugo mod tidy
59
+ ```
60
+
61
+ ## Fork
62
+
63
+ The contents below are from the original Geekdoc README.
64
+
65
+ ---
2
66
3
67
[ ![ Build Status] ( https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg )] ( https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc )
4
68
[ ![ Hugo Version] ( https://img.shields.io/badge/hugo-0.112-blue.svg )] ( https://gohugo.io )
You can’t perform that action at this time.
0 commit comments