Beautiful documentation for your API.
Visit the demo site.
Note that this theme needs Pygments installed to render code samples. See 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.
If you want a different page selection, please provide your own
When the fix for #2549 is released we may do this with blocks, but until then you can provide some custom partials:
partials/hook_head_end.htmlis inserted right before the
headend tag. Useful for additional styles etc.
partials/hook_body_end.htmlwhich should be clear by its name.
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 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, 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 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
fswatch (OSX only, I believe) available, you can get a fairly enjoyable live-reloading development experience for all artifacts by running:
hugo serverin your Hugo site project.
make servein the theme folder.