diff options
| author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2016-10-20 21:00:47 +0300 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2016-10-20 21:00:47 +0300 |
| commit | ff32472f5d9723c275f14615916db9ba49b61693 (patch) | |
| tree | 7801d539447701935e1ea5dbf7249fb63a1cf1eb /README.md | |
| parent | c908e3099512d8671a13ec256e819b683bd5e614 (diff) | |
Use absolute GitHub links
For the Hugo themes site to render them correctly.
Fixes #3
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -1,10 +1,12 @@ **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/lord/slate) project ([Apache 2 License](https://github.com/lord/slate/blob/master/LICENSE)). - + ## Use -See the [exampleSite](/exampleSite) and more specific its site [configuration](/exampleSite/config.toml) for the available options. +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. + +**Note that this theme needs Pygments installed to render code samples. See [pygments.org](http://pygments.org/)** **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. @@ -18,7 +20,7 @@ But you may find styling issues, etc., that you want to fix. Pull requests of th **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 when that is done.** -This project provides a very custom asset bundler in [bundler.go](bundler.go) written in Go. +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: |