Update README.md
This commit is contained in:
Alex Shpak
parent
e62448627e
commit
eafb4bfa6c
2 changed files with 45 additions and 27 deletions
68
README.md
68
README.md
|
|
@ -1,47 +1,43 @@
|
||||||
# Hugo Book Theme
|
# Hugo Book Theme
|
||||||
### Documentation theme as simple as plain book
|
### [Hugo](https://gohugo.io) documentation theme as simple as plain book
|
||||||
|
|
||||||
Description, motivation
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
* Clean simple design
|
* Clean simple design
|
||||||
* Mobile friendly
|
* Mobile friendly
|
||||||
* Customizable menu
|
* Customizable
|
||||||
* Renders single site section (`docs` by default)
|
* Designed to not interfere with main website
|
||||||
|
* Zero initial configuration
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
Navigate to your hugo website root and run:
|
||||||
```
|
```
|
||||||
git clone ...
|
git clone git@github.com:alex-shpak/hugo-book.git themes/book
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run hugo (or set `theme: book` in configuration file)
|
||||||
|
```
|
||||||
|
hugo server --theme book
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
### Menu
|
### File tree menu (default)
|
||||||
There are two options to render menu:
|
By default theme will render pages from `content/docs` section as menu in a tree structure.
|
||||||
1. Use file tree as menu (Option by default).
|
You can set `title` and `weight` in front matter of pages to adjust order and titles in menu.
|
||||||
You can set `title` and `weight` in front matter to adjust menu.
|
|
||||||
|
|
||||||
2. Use leaf bundle and content of it's `index.md` as
|
|
||||||
|
### Leaf bundle menu
|
||||||
|
You can also use leaf bundle and content of it's `index.md` as
|
||||||
menu.
|
menu.
|
||||||
You can enable it by pointing to leaf bundle with `BookMenuBundle` parameter on Site level.
|
Enable it by pointing to leaf bundle with `BookMenuBundle` parameter on Site level.
|
||||||
|
- [Example menu](exampleSite/content/menu)
|
||||||
```md
|
- [Example config file](exampleSite/config.yml)
|
||||||
- [**Introduction**](/docs/introduction/)
|
- [Leaf bundles](https://gohugo.io/content-management/page-bundles/)
|
||||||
- [Motivation](/docs/motivation/)
|
|
||||||
- [Configuration](/docs/configuration/)
|
|
||||||
- [Server](/docs/configuration/server/)
|
|
||||||
- [Client](/docs/configuration/client/)
|
|
||||||
<br />
|
|
||||||
- [Addtional Information](docs/configuration/additional-information/)
|
|
||||||
- [*Links*](/docs/links/)
|
|
||||||
```
|
|
||||||
|
|
||||||
Also see [Example](exampleSite/content/menu) and [Site configuration](#site-configuration)
|
|
||||||
|
|
||||||
|
|
||||||
### Site configuration
|
### Site configuration
|
||||||
There is few configuration options you can add to your `config.yml|json|toml` file
|
There are few configuration options you can add to your `config.yml|json|toml` file
|
||||||
```yaml
|
```yaml
|
||||||
# (Optional) Set this to true if you use captial letters in file names
|
# (Optional) Set this to true if you use captial letters in file names
|
||||||
disablePathToLower: true
|
disablePathToLower: true
|
||||||
|
|
@ -75,11 +71,29 @@ weight: 10
|
||||||
# Set to mark page as top level section in file-tree menu (if BookMenuBundle not set)
|
# Set to mark page as top level section in file-tree menu (if BookMenuBundle not set)
|
||||||
bookTopSection: true
|
bookTopSection: true
|
||||||
|
|
||||||
# Set to hide table of contents, default true
|
# Set to hide table of contents, overrides global value
|
||||||
bookShowToC: false
|
bookShowToC: false
|
||||||
---
|
---
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Partials
|
||||||
|
There are few empty partials you can override in `layouts/partials/`
|
||||||
|
| Partial | Placement |
|
||||||
|
| -- | -- |
|
||||||
|
| layouts/partials/docs/inject/head.html | Before closing `<head>` tag |
|
||||||
|
| layouts/partials/docs/inject/body.html | Before closing `<body>` tag |
|
||||||
|
| layouts/partials/docs/inject/nav-before.html | Before `<nav>` menu block |
|
||||||
|
| layouts/partials/docs/inject/nav-after.html | After `<nav>` menu block |
|
||||||
|
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
Contributions are welcome and I will review and consider pull requests.
|
||||||
|
Primary goals are:
|
||||||
|
- Keep it simple
|
||||||
|
- Keep minimal (or zero) default configuration
|
||||||
|
- Avoid interference with user-defined layouts
|
||||||
|
|
||||||
|
If you missing some configuration or customisation option feel free to open issue.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
[MIT](LICENSE)
|
[MIT](LICENSE)
|
||||||
|
|
@ -3,6 +3,10 @@
|
||||||
$block-border-radius: 0.15rem;
|
$block-border-radius: 0.15rem;
|
||||||
|
|
||||||
.markdown {
|
.markdown {
|
||||||
|
h1, h2, h3, h4, h5 {
|
||||||
|
font-weight: 400;
|
||||||
|
}
|
||||||
|
|
||||||
a {
|
a {
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue