README.md 1.46 KB
Newer Older
1
# Bootie Docs
key-amb's avatar
key-amb committed
2

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

key-amb's avatar
key-amb committed
6
![Bootie Docs screenshot](https://raw.githubusercontent.com/key-amb/hugo-theme-bootie-docs/master/images/tn.png)
key-amb's avatar
key-amb committed
7
8

You can see demo and full documentation at http://key-amb.github.io/bootie-docs-demo/ .
key-amb's avatar
key-amb committed
9

10
11
## CONTENTS

key-amb's avatar
key-amb committed
12
13
14
* [QUICKSTART](#quickstart)
* [OPTIONS](#options)
* [LIMITATION](#limitation)
15
16
17
* [DEPENDENCIES](#dependencies)
* [LICENSE](#license)

key-amb's avatar
key-amb committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
## 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]
  mainMenu = ["about", "usage"]
```

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.

41
42
## DEPENDENCIES

43
**Bootie Docs** includes following libraries:
44

45
* [Bootstrap](http://getbootstrap.com/) v3.3.4 ... Well-known CSS framework.
46
* [jQuery](https://jquery.com/) v1.11.2 ... Requried by _Bootstrap_.
47
* [highlight.js](https://highlightjs.org/) v8.5 ... For syntax highlighting.
48
49
50
51
52

## LICENSE

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