README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# Bootie Docs

**Bootie Docs** is a simple [hugo](http://gohugo.io/) theme for documentation.  
The name "bootie" comes from [Bootstrap](http://getbootstrap.com/) CSS.

![Bootie Docs screenshot](https://raw.githubusercontent.com/key-amb/hugo-theme-bootie-docs/master/images/tn.png)

You can see demo and full documentation at http://key-amb.github.io/bootie-docs-demo/ .

## CONTENTS

* [QUICKSTART](#quickstart)
* [OPTIONS](#options)
* [LIMITATION](#limitation)
* [DEPENDENCIES](#dependencies)
* [LICENSE](#license)

## QUICKSTART

1. `hugo new _index.md`
1. Edit `content/_index.md`

Then the content appears on top page.

## OPTIONS

You can customize the menu items in the header navigation bar by configuring `params.mainMenu` in your _config.toml_ (or _config.yaml_).

```
# example of config.toml
[params]
  highlightStyle = "github"

[[params.mainMenu]]
  name = "Usage"
  link = "usage"

[[params.mainMenu]]
  name = "News"
  link = "categories/news"
```

All other options and usages are described at the documentation site -- http://key-amb.github.io/bootie-docs-demo/ .

## LIMITATION

Because _Bootie Docs_ is developed for documentation, it lacks many blog-type facilities such as RSS feeds, pagination of posts and so on.

## DEPENDENCIES

**Bootie Docs** includes following libraries:

* [Bootstrap](http://getbootstrap.com/) v3.3.6 ... Well-known CSS framework.
* [jQuery](https://jquery.com/) v1.12.3 ... Requried by _Bootstrap_.
* [highlight.js](https://highlightjs.org/) v9.3.0 ... For syntax highlighting.

## LICENSE

Copyright (C) 2015-2016 YASUTAKE Kiyoshi.  
Released under the MIT License.