diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-07-25 19:47:54 +0300 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-07-25 19:50:27 +0300 |
commit | ffa94760b9005cb00a3076ab44cad48164e59e58 (patch) | |
tree | 92ed0c5be36a7ae8ebf1c7bb0ae9459329efd949 | |
parent | 7ffe862b37fe1054e73b9d53c23b7ba0f7046da1 (diff) |
Update README
-rw-r--r-- | README.md | 34 | ||||
-rw-r--r-- | config.toml | 2 |
2 files changed, 6 insertions, 30 deletions
@@ -10,12 +10,16 @@ ## Use +**Note:** this theme requires Hugo >= 0.56.0 to run. If you want to edit the SCSS styles, you need the extended version. + 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. **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. If you want a different page selection, please provide your own `layouts/index.html` template. +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. + ## Hooks 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 * `partials/styles.html` * `partials/js.html` -## Develop the Theme - -**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. - -But you may find styling issues, etc., that you want to fix. Those Pull Requests are warmly welcomed! - -**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.** - -This project provides a very custom asset bundler in [bundler.go](https://github.com/bep/docuapi/blob/master/bundler.go) written in Go. - -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: - -* `go get -u -v .` -* `go run bundler.go` (this will clone Slate to a temp folder) -* Alternative to the above if you already have Slate cloned somewhere: `go run bundler.go -slate=/path/to/Slate` - -All options: - -```bash -go run bundler.go -h - -minify - apply minification to output Javascript, CSS etc. (default true) - -slate string - the path to the Slate source, if not set it will be cloned from https://github.com/lord/slate.git -``` - -With `make` and `fswatch` (OSX only, I believe) available, you can get a fairly enjoyable live-reloading development experience for all artifacts by running: - -* `hugo server` in your Hugo site project. -* `make serve` in the theme folder. diff --git a/config.toml b/config.toml index 98e8247..69388d3 100644 --- a/config.toml +++ b/config.toml @@ -2,6 +2,8 @@ baseURL = "https://example.com/" [module] +[module.hugoVersion] +min = "0.56.0" [[module.imports]] path="github.com/lord/slate" [[module.imports.mounts]] |