You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-30Lines changed: 4 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,16 @@
10
10
11
11
## Use
12
12
13
+
**Note:** this theme requires Hugo >= 0.56.0 to run. If you want to edit the SCSS styles, you need the extended version.
14
+
13
15
See the [exampleSite](https://github.com/bep/docuapi/tree/master/exampleSite) and more specific its site [configuration](https://github.com/bep/docuapi/blob/master/exampleSite/config.toml) for the available options.
14
16
15
17
**Most notable:** This theme will use all the (non drafts) pages in the site and build a single-page API documentation. Using `weight` in the page front matter is the easiest way to control page order.
16
18
17
19
If you want a different page selection, please provide your own `layouts/index.html` template.
18
20
21
+
You can customize the look-and-feel by adding your own CSS variables in `assets/scss/docuapi_overrides.scss`. See the exampleSite folder for an example.
22
+
19
23
## Hooks
20
24
21
25
When the fix for [#2549](https://github.com/spf13/hugo/issues/2549) is released we may do this with blocks, but until then you can provide some custom partials:
@@ -31,36 +35,6 @@ The styles and Javascript import are also put in each partial and as such can be
31
35
*`partials/styles.html`
32
36
*`partials/js.html`
33
37
34
-
## Develop the Theme
35
-
36
-
**Note:** In most situations you will be well off just using the theme and maybe in some cases provide your own template(s). Please refer to the [Hugo Documentation](http://gohugo.io/overview/introduction/) for that.
37
-
38
-
But you may find styling issues, etc., that you want to fix. Those Pull Requests are warmly welcomed!
39
-
40
-
**If you find issues that obviously belongs to [Slate](https://github.com/lord/slate), then please report/fix them there, and we will pull in the latest changes here.**
41
-
42
-
This project provides a very custom asset bundler in [bundler.go](https://github.com/bep/docuapi/blob/master/bundler.go) written in Go.
43
-
44
-
It depends on `libsass` to build, so you will need `gcc` (a C compiler) to build it for your platform. If that is present, you can try:
45
-
46
-
*`go get -u -v .`
47
-
*`go run bundler.go` (this will clone Slate to a temp folder)
48
-
* Alternative to the above if you already have Slate cloned somewhere: `go run bundler.go -slate=/path/to/Slate`
49
-
50
-
All options:
51
-
52
-
```bash
53
-
go run bundler.go -h
54
-
-minify
55
-
apply minification to output Javascript, CSS etc. (default true)
56
-
-slate string
57
-
the path to the Slate source, if not set it will be cloned from https://github.com/lord/slate.git
58
-
```
59
-
60
-
With `make` and `fswatch` (OSX only, I believe) available, you can get a fairly enjoyable live-reloading development experience for all artifacts by running:
0 commit comments