a bootstrap HUGO theme for documentation
JavaScript HTML CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
archetypes
exampleSite updated base url #1 Nov 7, 2016
images added screenshot back :) Apr 24, 2016
layouts
static
.gitignore initial version Apr 20, 2016
LICENSE.md initial version Apr 20, 2016
README.md README updated #2 Nov 9, 2016
theme.toml fix on them name Apr 21, 2016

README.md

DarkDoc Theme

DarkDoc Theme is a bootstrap to document a project. It will create links to github downloads and demo web site if any and display project stars.

Hugo DarkDoc Theme screenshot

Installation

Inside the folder of your Hugo site run:

$ mkdir themes
$ cd themes
$ git clone https://github.com/adejoux/hugo-darkdoc-theme

For more information read the official setup guide of Hugo.

example web site

Take a look inside the exampleSite folder of this theme.

It's a example website you can use as starting point to build your site. You'll find a file called config.toml. To use it, copy it in the root folder of your Hugo site. Change the parameters accordingly to your site.

features

syntax highlighting

It's using python pygments. Install it easily with pip or your system packages:

pip install pygments

gallery

This theme use fancybox to display gallery images.

{{< gallery image="space1.jpg" >}}
{{< gallery image="space2.jpg" addclass="hidden" >}}

menu

The main menu entry are specified in config.toml:

[[menu.main]]
	name   = "Demo"
	url    = "demo/"
	weight = 0

Each document can be attached to a entry by adding this elements in the frontmatter section:

menu:
  main:
    parent: Demo
    identifier: /demo/live
    weight: 10

To add a menu

Contributing

Did you found a bug or got an idea for a new feature? Feel free to use the issue tracker to let me know. Or make directly a pull request.

License

This theme is released under the MIT License. For more information read the License.

Annotations

Thanks to Steve Francia for creating Hugo and the awesome community around the project.