README.md 1.75 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

6
![Bootie Docs screenshot](https://raw.githubusercontent.com/progrhyme/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://progrhyme.github.io/bootie-docs-demo/ .
key-amb's avatar
key-amb committed
9

10
11
## CONTENTS

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

key-amb's avatar
key-amb committed
19
20
21
22
23
24
25
## QUICKSTART

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

Then the content appears on top page.

26
## MENUS
key-amb's avatar
key-amb committed
27

28
29
You can customize the menu items in the header navigation bar by configuring `menu.main` in your
_config.toml_ (or _config.yaml_) supported by Hugo's [Menu System](https://gohugo.io/extras/menus/).
key-amb's avatar
key-amb committed
30
31
32
33

```
# example of config.toml
[params]
key-amb's avatar
key-amb committed
34
  highlightStyle = "github"
35

36
37
38
39
[[menu.main]]
  name   = "Usage"
  url    = "/usage/"
  weight = 10
40

41
42
43
44
[[menu.main]]
  name   = "News"
  url    = "/categories/news/"
  weight = 20
key-amb's avatar
key-amb committed
45
46
```

47
48
49
50
51
52
53
NOTE:

- Nested menus are not supported.

## OPTIONS

All other options and usages for _Bootie Docs_ are described at the documentation site --
54
http://progrhyme.github.io/bootie-docs-demo/ .
key-amb's avatar
key-amb committed
55
56
57

## LIMITATION

58
59
Because _Bootie Docs_ is developed for documentation, it lacks many blog-type facilities such as RSS
feeds, pagination of posts and so on.
key-amb's avatar
key-amb committed
60

61
62
## DEPENDENCIES

63
**Bootie Docs** includes following libraries:
64

progrhyme's avatar
progrhyme committed
65
* [Bootstrap](http://getbootstrap.com/) v3.3.7 ... Well-known CSS framework.
progrhyme's avatar
progrhyme committed
66
* [jQuery](https://jquery.com/) v3.2.1 ... Requried by _Bootstrap_.
progrhyme's avatar
progrhyme committed
67
* [highlight.js](https://highlightjs.org/) v9.12.0 ... For syntax highlighting.
68
69
70

## LICENSE

key-amb's avatar
key-amb committed
71
Copyright (C) 2015-2017 IKEDA Kiyoshi.  
72
Released under the MIT License.