#50, Keep both yaml and toml examples in exampleSite

soper-book
Alex Shpak 2019-05-22 10:23:34 +02:00
parent 12f98cc2a5
commit ddfb4bafb7
3 changed files with 56 additions and 11 deletions

View File

@ -88,7 +88,7 @@ headless = true
And Enable it by settings `BookMenuBundle: /menu` in Site configuration
- [Example menu](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/content/menu/index.md)
- [Example config file](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yml)
- [Example config file](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yaml)
- [Leaf bundles](https://gohugo.io/content-management/page-bundles/)
## Blog
@ -99,8 +99,8 @@ Simple blog supported for section `posts`
### Site Configuration
There are few configuration options you can add to your `config.yml|json|toml` file.
See `yaml` example [here](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yml)
There are few configuration options you can add to your `config.toml` file.
You can also see `yaml` example [here](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yaml).
```toml
# (Optional) Set this to true if you use capital letters in file names
@ -153,8 +153,7 @@ BookDateFormat = 'Jan 2, 2006'
You can specify additional params per page in front matter
```md
+++
```toml
# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'
type = 'docs'
@ -169,9 +168,6 @@ bookHidden = true
# (Optional) Set true to hide table of contents, overrides global value
bookShowToC = false
+++
# Markdown content below
```
### Partials

49
exampleSite/config.toml Normal file
View File

@ -0,0 +1,49 @@
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/example
baseURL = 'https://example.com/'
title = 'Hugo Book'
theme = 'hugo-book'
disableKinds = ['taxonomy', 'taxonomyTerm']
# themesDir = '../..'
# Book configuration
disablePathToLower = true
enableGitInfo = true
# Code highlight
pygmentsStyle = 'monokailight'
pygmentsCodeFences = true
[params]
# (Optional, default true) Show or hide table of contents globally
# You can also specify this parameter per page in front matter
BookShowToC = true
# (Optional, default none) Set leaf bundle to render as side menu
# When not specified file structure and weights will be used
BookMenuBundle = '/menu'
# (Optional, default docs) Specify section of content to render as menu
# You can also set value to '*' to render all sections to menu
BookSection = 'docs'
# This value is duplicate of $link-color for making active link highlight in menu bundle mode
# BookMenuBundleActiveLinkColor = '\#004ed0'
# Include JS scripts in pages. Disabled by default.
# - Keep side menu on same scroll position during navigation
BookEnableJS = true
# Set source repository location.
# Used for 'Last Modified' and 'Edit this page' links.
BookRepo = 'https://github.com/alex-shpak/hugo-book'
# Enable "Edit this page" links for 'doc' page type.
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
# Path must point to 'content' directory of repo.
BookEditPath = 'edit/master/exampleSite/content'
# Configure the date format used on the pages
# - In git information
# - In blog posts
BookDateFormat = 'Jan 2, 2006'

View File

@ -3,7 +3,7 @@
baseURL: https://example.com/
title: Hugo Book
theme: hugo-book
disableKinds: ["taxonomy", "taxonomyTerm"]
disableKinds: ['taxonomy', 'taxonomyTerm']
# themesDir: ../..
# Book configuration
@ -24,7 +24,7 @@ params:
BookMenuBundle: /menu
# (Optional, default docs) Specify section of content to render as menu
# You can also set value to "*" to render all sections to menu
# You can also set value to '*' to render all sections to menu
BookSection: docs
# This value is duplicate of $link-color for making active link highlight in menu bundle mode
@ -46,4 +46,4 @@ params:
# Configure the date format used on the pages
# - In git information
# - In blog posts
BookDateFormat: "Jan 2, 2006"
BookDateFormat: 'Jan 2, 2006'