Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 1.46 KB

themeReadMe.md

File metadata and controls

52 lines (33 loc) · 1.46 KB
Raw

Bootie Docs

Bootie Docs is a simple hugo theme for documentation.
The name "bootie" comes from Bootstrap CSS.

Bootie Docs screenshot

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

CONTENTS

QUICKSTART

  1. hugo new _index.md
  2. 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:

  • Bootstrap v3.3.4 ... Well-known CSS framework.
  • jQuery v1.11.2 ... Requried by Bootstrap.
  • highlight.js v8.5 ... For syntax highlighting.

LICENSE

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