diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -1,6 +1,6 @@ [](https://app.netlify.com/sites/docuapi/deploys) -**DocuAPI** is a beautiful multilingual API documentation theme for [Hugo](http://gohugo.io/). This theme is built on top of the beautiful work of [Robert Lord](https://github.com/lord) and others on the [Slate](https://github.com/slatedocs/slate) project ([Apache 2 License](https://github.com/slatedocs/slate/blob/master/LICENSE)). +**DocuAPI** is a beautiful multilingual API documentation theme for [Hugo](http://gohugo.io/). This theme is built on top of the beautiful work of [Robert Lord](https://github.com/lord) and others on the [Slate](https://github.com/slatedocs/slate) project ([Apache 2 License](https://github.com/slatedocs/slate/blob/master/LICENSE)). The JS part has recently been rewritten from Jquery to [AlpineJS](https://alpinejs.dev/). <br/> @@ -12,16 +12,16 @@ ## Use -The client library used to build the ToC does not handle Unicode very well. To get around this in Hugo >= 0.62.2, put this in your site config: +Import the theme in your Hugo config: ```toml -[markup] - [markup.goldmark] - [markup.goldmark.parser] - autoHeadingIDType = "github-ascii" +[[module.imports]] +path = "github.com/bep/docuapi/v2" ``` -**Note:** this theme requires Hugo >= 0.56.0 to run. If you want to edit the SCSS styles, you need: +Note, if you want the older jQuery-versjon, replace the path with `github.com/bep/docuapi`. + +If you want to edit the SCSS styles, you need: * The extended Hugo version. * PostCSS CLI (run `npm install` to install requirements) |