Unverified Commit 69735328 authored by Ethan Madison's avatar Ethan Madison
Browse files

Merge branch 'master' of progrhyme/hugo-theme-bootie-docs

Brings in most of the changes from the past ~1.5 years, except those
totally unrelated.
parents 50eb545d e8c73915
## 1.5.1 (2018/3/28)
Fix:
- Add `img` property "max-width" in CSS (#34)
- Fix #33 by Dmitry Verkhoturov (@paskal)
## 1.5.0 (2017/7/30)
Change:
- Upgrade dependent components (#32):
- bootstrap.css to v3.3.7 (was v3.3.6)
- jQuery to v3.2.1 (was v1.12.3)
- highlight.js to v9.12.0 (was v9.3.0)
## 1.4.0 (2017/7/20)
Change:
- Move repository location from [@key-amb's](https://github.com/key-amb/) to
[@progrhyme's](https://github.com/progrhyme/) (#31)
## 1.3.2 (2017/5/21)
Improve:
- Add media query for sidebar so that it don't overlay screen in narrow browsers
(#29) @jodumont
## 1.3.1 (2017/3/5)
Enhance:
- Add site-customized CSS as `static/css/site.css` for one to customize site's
look & feel (#27)
## 1.3.0 (2017/3/5)
Change:
- Apply Hugo's [Menu System](https://gohugo.io/extras/menus/) for header
navigation (#26)
## 1.2.0 (2017/1/12)
Change:
- Use `.IsHome` to detect site home (#21)
- Fix #20 by Ethan Madison (@ethanmad)
- Not to append trailing `"/"` to match menu link in header.html (#21)
## 1.1.3 (2017/1/11)
Fix:
- Avoid to use `{{ if isset .Params "fooBar" }}` syntax because it doesn't work
for Hugo v0.18.x currently (#19)
- Fix #18 by Ethan Madison (@ethanmad)
## 1.1.2 (2017/1/5)
Improve:
- Removes extra padding-bottom in `body` tag which is in no need (#17)
- Fix #16 by Ethan Madison (@ethanmad)
>>>>>>> e8c73915e02309ad25ac6672503f6dee1d6b05f4
## 1.1.1 (2016/5/7)
Change:
......
The MIT License (MIT)
Copyright (c) 2015-2016 YASUTAKE Kiyoshi
Copyright (c) 2015-2017 IKEDA Kiyoshi
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
......
......@@ -3,13 +3,14 @@
**Bootie Docs** is a simple [hugo](http://gohugo.io/) theme for documentation.
The name "bootie" comes from [Bootstrap](http://getbootstrap.com/) CSS.
![Bootie Docs screenshot](https://raw.githubusercontent.com/key-amb/hugo-theme-bootie-docs/master/images/tn.png)
![Bootie Docs screenshot](https://raw.githubusercontent.com/progrhyme/hugo-theme-bootie-docs/master/images/tn.png)
You can see demo and full documentation at http://key-amb.github.io/bootie-docs-demo/ .
You can see demo and full documentation at http://progrhyme.github.io/bootie-docs-demo/ .
## CONTENTS
* [QUICKSTART](#quickstart)
* [MENUS](#menus)
* [OPTIONS](#options)
* [LIMITATION](#limitation)
* [DEPENDENCIES](#dependencies)
......@@ -22,39 +23,50 @@ You can see demo and full documentation at http://key-amb.github.io/bootie-docs-
Then the content appears on top page.
## OPTIONS
## MENUS
You can customize the menu items in the header navigation bar by configuring `params.mainMenu` in your _config.toml_ (or _config.yaml_).
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/).
```
# example of config.toml
[params]
highlightStyle = "github"
[[params.mainMenu]]
name = "Usage"
link = "usage"
[[menu.main]]
name = "Usage"
url = "/usage/"
weight = 10
[[params.mainMenu]]
name = "News"
link = "categories/news"
[[menu.main]]
name = "News"
url = "/categories/news/"
weight = 20
```
All other options and usages are described at the documentation site -- http://key-amb.github.io/bootie-docs-demo/ .
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.
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](http://getbootstrap.com/) v3.3.6 ... Well-known CSS framework.
* [jQuery](https://jquery.com/) v1.12.3 ... Requried by _Bootstrap_.
* [highlight.js](https://highlightjs.org/) v9.3.0 ... For syntax highlighting.
* [Bootstrap](http://getbootstrap.com/) v3.3.7 ... Well-known CSS framework.
* [jQuery](https://jquery.com/) v3.2.1 ... Requried by _Bootstrap_.
* [highlight.js](https://highlightjs.org/) v9.12.0 ... For syntax highlighting.
## LICENSE
Copyright (C) 2015-2016 YASUTAKE Kiyoshi.
Copyright (C) 2015-2017 IKEDA Kiyoshi.
Released under the MIT License.
......@@ -17,6 +17,7 @@
<link rel="stylesheet" href="{{ $baseUrl }}/css/theme.css">
<link rel="stylesheet" href="{{ $baseUrl }}/css/bootie-docs.css">
<link rel="stylesheet" href="{{ $baseUrl }}/css/font-awesome.min.css">
<link rel="stylesheet" href="{{ $baseUrl }}/css/site.css">
</head>
<body role="document">
......@@ -35,12 +36,11 @@
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li {{ if .IsHome}}class="active"{{ end }}><a href="{{ $baseUrl }}/">Home</a></li>
{{ $url := .Permalink }}
{{ with .Site.Params.mainMenu }}
<li {{ if .IsHome }}class="active"{{ end }}><a href="{{ $baseUrl }}/">Home</a></li>
{{ $url := .URL }}
{{ with .Site.Menus.main }}
{{ range $menu := . }}
{{ $itemUrl := printf "%s/%s/" $baseUrl $menu.link }}
<li {{ if eq $url $itemUrl }}class="active"{{ end }}><a href="{{ $baseUrl }}/{{ $menu.link }}">{{ $menu.name }}</a></li>
<li {{ if eq $url .URL }}class="active"{{ end }}><a href="{{ .URL }}">{{ .Name }}</a></li>
{{ end }}
{{ end }}
{{ if not .Site.Params.noCategoryLink }}
......
......@@ -24,6 +24,10 @@ h2, .h2 {
margin-bottom: 15px;
}
img {
max-width: 100%;
}
/* Override Bootstrap's style not to break line in code blocks */
pre {
overflow: auto;
......@@ -184,8 +188,9 @@ article > section > table > tbody > tr:nth-of-type(odd) {
/*
* Sidebar
*/
div#sidebar {
@media (min-width: 1200px) {
div#sidebar {
}
}
/* Sidebar modules for boxing content */
......
This diff is collapsed.
This source diff could not be displayed because it is too large. You can view the blob instead.
/*
* You can add styles to customize UI for your own site
* into CSS file: static/css/site.css
*/
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
name = "Hugo Theme Bootie Docs"
license = "MIT"
licenselink = "https://github.com/key-amb/hugo-theme-bootie-docs/LICENSE.md"
licenselink = "https://github.com/progrhyme/hugo-theme-bootie-docs/LICENSE.md"
description = "A simple Hugo theme with Bootstrap for documentation"
homepage = "http://key-amb.github.io/bootie-docs-demo/"
tags = ["document", "bootstrap"]
features = ["document", ""]
min_version = 0.14
homepage = "http://progrhyme.github.io/bootie-docs-demo/"
tags = ["documentation", "bootstrap", "simple", "highlight.js"]
features = ["documentation", ""]
min_version = 0.15
[author]
name = "YASUTAKE Kiyoshi"
homepage = "https://github.com/key-amb"
name = "IKEDA Kiyoshi"
homepage = "https://github.com/progrhyme"
# If porting an existing theme
[original]
......
Markdown is supported
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