Giter VIP home page Giter VIP logo

hugo-theme-bootie-docs's Introduction

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://progrhyme.github.io/bootie-docs-demo/ .

CONTENTS

QUICKSTART

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

Then the content appears on top page.

MENUS

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.

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

[[menu.main]]
  name   = "Usage"
  url    = "/usage/"
  weight = 10

[[menu.main]]
  name   = "News"
  url    = "/categories/news/"
  weight = 20

NOTE:

  • Nested menus are not supported.

OPTIONS

All other options and usages for Bootie Docs are described at the documentation site -- http://progrhyme.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.7 ... Well-known CSS framework.
  • jQuery v3.2.1 ... Requried by Bootstrap.
  • highlight.js v9.12.0 ... For syntax highlighting.

LICENSE

Copyright (C) 2015-2017 IKEDA Kiyoshi.
Released under the MIT License.

hugo-theme-bootie-docs's People

Contributors

bep avatar jodumont avatar key-amb avatar progrhyme avatar sdebruyn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.