Commit 5897f563 authored by key-amb's avatar key-amb
Browse files

Add descriptions

parent a2d4859d
......@@ -3,13 +3,41 @@
**Bootie Docs** is a simple [hugo](http://gohugo.io/) theme for documentation.
The name "bootie" comes from [Bootstrap](http://getbootstrap.com/) CSS.
You can see Demo and documents of **Bootie Docs** at http://key-amb.github.io/bootie-docs-demo/ .
![Bootie Docs screenshot](https://raw.githubusercontent.com/key-amb/hugo-theme-bootie-docs/master/static/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]
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.
## DEPENDENCIES
**Bootie Docs** includes following libraries:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment