setup
This commit is contained in:
Simon Gardling
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: 'Configuration'
|
||||
type: 'bookcase'
|
||||
---
|
||||
|
||||
These documents show some customizable values that are used in this theme. By adjusting these values, you can easily change the behavior of your website without touching the source code.
|
||||
|
||||
You can refer to the example config in [github](https://github.com/kaiiiz/hugo-theme-monochrome/tree/main/exampleSite/config).
|
||||
@@ -0,0 +1,217 @@
|
||||
---
|
||||
title: 'Page Settings'
|
||||
weight: 3
|
||||
bookcase_cover_src: 'cover/catalogue.png'
|
||||
bookcase_cover_src_dark: 'cover/catalogue_dark.png'
|
||||
changelogs:
|
||||
---
|
||||
|
||||
# Page Settings
|
||||
|
||||
These values are inside your page's front-matter.
|
||||
|
||||
## Layout
|
||||
|
||||
Monochrome support different types of layout. You can change the layout of section or regular page according to your needs. Checkout [Layout](/hugo-theme-monochrome/layouts) for more details.
|
||||
|
||||
## Navbar title
|
||||
|
||||
HTML is available.
|
||||
|
||||
```yaml
|
||||
---
|
||||
navbar_title: "Monochrome"
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`navbar_title`](/hugo-theme-monochrome/configuration/theme#navbar-title)
|
||||
|
||||
## Footer
|
||||
|
||||
HTML is available.
|
||||
|
||||
```yaml
|
||||
---
|
||||
footer: "Copyright © 2021 by kaiiiz"
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`footer`](/hugo-theme-monochrome/configuration/theme/#footer)
|
||||
|
||||
## Site Search
|
||||
|
||||
Hide the page from the search result.
|
||||
|
||||
```yaml
|
||||
search_hidden: true
|
||||
```
|
||||
|
||||
> default: false
|
||||
|
||||
## Table of Contents
|
||||
|
||||
```yaml
|
||||
---
|
||||
toc: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_toc`](/hugo-theme-monochrome/configuration/theme/#table-of-contents)
|
||||
|
||||
### Collapsible Table of Contents
|
||||
|
||||
```yaml
|
||||
---
|
||||
collapsible_toc: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_collapsible_toc`](/hugo-theme-monochrome/configuration/theme/#collapsible-menu)
|
||||
|
||||
## Changelogs
|
||||
|
||||
```yaml
|
||||
---
|
||||
changelogs:
|
||||
- tag: '20210623'
|
||||
description:
|
||||
- 'changelog example 1'
|
||||
- 'changelog example 2'
|
||||
- tag: '20210624'
|
||||
description:
|
||||
- 'changelog example 3'
|
||||
- 'changelog example 4'
|
||||
---
|
||||
```
|
||||
|
||||
tag and description both support markdown syntax.
|
||||
|
||||
> default: None
|
||||
|
||||
### Collapsible Changelogs
|
||||
|
||||
```yaml
|
||||
---
|
||||
collapsible_changelogs: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_collapsible_changelogs`](/hugo-theme-monochrome/configuration/theme/#collapsible-menu)
|
||||
|
||||
## External library
|
||||
|
||||
### MathJax
|
||||
|
||||
```yaml
|
||||
---
|
||||
math: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_math`](/hugo-theme-monochrome/configuration/theme/#mathjax)
|
||||
|
||||
### Zooming.js
|
||||
|
||||
```yaml
|
||||
---
|
||||
zooming_js: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_zooming_js`](/hugo-theme-monochrome/configuration/theme/#zooming_js)
|
||||
|
||||
### Disqus
|
||||
|
||||
```yaml
|
||||
---
|
||||
disqus: false
|
||||
---
|
||||
```
|
||||
|
||||
> default for post page: site's [`disqusShortname`](/hugo-theme-monochrome/zh-tw/configuration/site/#disqus)
|
||||
>
|
||||
> default for other pages: false
|
||||
|
||||
### Google Analytics
|
||||
|
||||
```yaml
|
||||
---
|
||||
ga: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: site's [`googleAnalytics`](/hugo-theme-monochrome/configuration/site/#google-analytics)
|
||||
|
||||
## Syntax Highlighting
|
||||
|
||||
### Chroma
|
||||
|
||||
```yaml
|
||||
---
|
||||
code_copy: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_code_copy`](/hugo-theme-monochrome/configuration/theme/#using-chroma-hugo-built-in)
|
||||
|
||||
## SEO
|
||||
|
||||
### Author
|
||||
|
||||
```yaml
|
||||
---
|
||||
author: "kaiiiz"
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`author`](/hugo-theme-monochrome/configuration/theme/#author)
|
||||
|
||||
### Description
|
||||
|
||||
```yaml
|
||||
---
|
||||
description: "Configuration of hugo-theme-monochrome"
|
||||
---
|
||||
```
|
||||
|
||||
> default: not generate description `meta` tag
|
||||
|
||||
### Keywords
|
||||
|
||||
In page front-matter
|
||||
|
||||
```yaml
|
||||
---
|
||||
keywords:
|
||||
- hugo
|
||||
- hugo theme
|
||||
- hugo theme monochrome
|
||||
---
|
||||
```
|
||||
|
||||
> default: not generate keywords `meta` tag
|
||||
|
||||
|
||||
### Open Graph
|
||||
|
||||
A flag to render open graph internal template. See [Open Graph](https://gohugo.io/templates/internal#open-graph) for additional settings.
|
||||
|
||||
```yaml
|
||||
---
|
||||
open_graph: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_open_graph`](/hugo-theme-monochrome/configuration/theme/#open-graph)
|
||||
|
||||
### Twitter Cards
|
||||
|
||||
A flag to render open twitter cards template. See [Twitter Cards](https://gohugo.io/templates/internal#twitter-cards) for additional settings.
|
||||
|
||||
```yaml
|
||||
---
|
||||
twitter_cards: false
|
||||
---
|
||||
```
|
||||
|
||||
> default: theme's [`enable_twitter_cards`](/hugo-theme-monochrome/configuration/theme/#twitter-cards)
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: 'Site Settings'
|
||||
weight: 1
|
||||
bookcase_cover_src: 'cover/catalogue.png'
|
||||
bookcase_cover_src_dark: 'cover/catalogue_dark.png'
|
||||
---
|
||||
|
||||
# Site Configuration
|
||||
|
||||
These settings are important for building a website using hugo. See [All Configuration Settings](https://gohugo.io/getting-started/configuration/#all-configuration-settings) for more details.
|
||||
|
||||
## Site title
|
||||
|
||||
Site title. This value will become the content of `<title>` tag in html.
|
||||
|
||||
```toml
|
||||
title = "Monochrome"
|
||||
```
|
||||
|
||||
## Theme
|
||||
|
||||
Set this value to the corresponding folder name of your theme. (located by default in `/themes/THEMENAME/`)
|
||||
|
||||
```toml
|
||||
theme = "hugo-theme-monochrome"
|
||||
```
|
||||
|
||||
## Base URL
|
||||
|
||||
Hostname (and path) to the root.
|
||||
|
||||
```toml
|
||||
baseURL = "https://kaiiiz.github.io/hugo-theme-monochrome"
|
||||
```
|
||||
|
||||
## favicon
|
||||
|
||||
Add `favicon.ico` to your site's static folder.
|
||||
|
||||
## External library
|
||||
|
||||
### Disqus
|
||||
|
||||
```toml
|
||||
disqusShortname = "xxx"
|
||||
```
|
||||
|
||||
Other settings checkout [Disqus - Internal Templates](https://gohugo.io/templates/internal/#disqus) for more details.
|
||||
|
||||
### Google Analytics
|
||||
|
||||
```toml
|
||||
googleAnalytics = "xxx"
|
||||
```
|
||||
@@ -0,0 +1,239 @@
|
||||
---
|
||||
title: 'Theme Settings'
|
||||
weight: 2
|
||||
bookcase_cover_src: 'cover/catalogue.png'
|
||||
bookcase_cover_src_dark: 'cover/catalogue_dark.png'
|
||||
changelogs:
|
||||
---
|
||||
|
||||
# Theme Configuration
|
||||
|
||||
These values are inside your toml config file.
|
||||
|
||||
## Navbar title
|
||||
|
||||
HTML is available.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
navbar_title = "Monochrome" # default: site's `title`
|
||||
```
|
||||
|
||||
## Footer
|
||||
|
||||
HTML is available.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
footer = "Copyright © 2021 by kaiiiz" # default: None
|
||||
```
|
||||
|
||||
## Table of Contents
|
||||
|
||||
TOC global settings.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
enable_toc = true # default: true
|
||||
```
|
||||
|
||||
## Collapsible Menu
|
||||
|
||||
Collapsible global settings.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
enable_collapsible_toc = false # default: false
|
||||
enable_collapsible_changelogs = false # default: false
|
||||
```
|
||||
## Navbar menu
|
||||
|
||||
Monochrome uses built-in menu system supported by hugo itself. (Checkout [document](https://gohugo.io/content-management/menus) for more deatil.) By default, the menu called `navbar` is used to decide which item need to be rendered on the navbar.
|
||||
|
||||
So you can simply add the following code to your page front-matter, and the menu info will be handled by hugo out of the box. ([simple method mentioned in document](https://gohugo.io/content-management/menus#simple))
|
||||
|
||||
```yaml
|
||||
---
|
||||
menu: navbar
|
||||
---
|
||||
```
|
||||
|
||||
Also, weighted value is supported out of the box, you can explicit assign the weight of the navbar entry, hugo will first sort the menu using weight, if there has two entries shared the same weight, the [default order](https://gohugo.io/templates/lists/#order-content) will be applied.
|
||||
|
||||
```yaml
|
||||
---
|
||||
menu:
|
||||
navbar:
|
||||
weight: -99
|
||||
---
|
||||
```
|
||||
|
||||
### Navbar settings in config
|
||||
If you try to put entry that aren't attached to a piece of content, or you want to organize your navbar into a single file, checkout [Add Non-content Entries to a Menu](https://gohugo.io/content-management/menus#add-non-content-entries-to-a-menu) or [Configuration file of demo site](https://github.com/kaiiiz/hugo-theme-monochrome/tree/main/exampleSite/config/_default/menus) and set these values in your toml settings file.
|
||||
|
||||
toml example:
|
||||
|
||||
```toml
|
||||
[[menu.navbar]]
|
||||
identifier = "about"
|
||||
name = "about"
|
||||
title = "about"
|
||||
url = "/about/"
|
||||
weight = 100
|
||||
|
||||
[[menu.navbar]]
|
||||
identifier = "series"
|
||||
name = "series"
|
||||
url = "/series/"
|
||||
weight = -100
|
||||
|
||||
[[menu.navbar]]
|
||||
identifier = "categories"
|
||||
name = "categories"
|
||||
url = "/categories/"
|
||||
weight = 80
|
||||
```
|
||||
|
||||
yaml example:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
navbar:
|
||||
- identifier: about
|
||||
name: about
|
||||
title: about
|
||||
url: /about/
|
||||
weight: 100
|
||||
- identifier: series
|
||||
name: series
|
||||
url: /series/
|
||||
weight: -100
|
||||
- identifier: categories
|
||||
name: categories
|
||||
url: /categories/
|
||||
weight: 80
|
||||
```
|
||||
|
||||
## List Layout
|
||||
|
||||
```toml
|
||||
[params]
|
||||
[params.list_layout]
|
||||
enable_group_by_year = true # default: true
|
||||
enable_show_date = true # default: true
|
||||
enable_pagination = false # default: false
|
||||
```
|
||||
|
||||
## External Library
|
||||
|
||||
### MathJax
|
||||
|
||||
Use `$` to create inline result, `$$` to create block result.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
enable_math = true # default: false
|
||||
```
|
||||
|
||||
### Zooming.js
|
||||
|
||||
Zooming.js global setting.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
enable_zooming_js = false # default: true
|
||||
```
|
||||
|
||||
### Site Search
|
||||
|
||||
Add the following settings to config.toml:
|
||||
|
||||
```toml
|
||||
[outputs]
|
||||
home = ["HTML", "RSS", "JSON"]
|
||||
```
|
||||
|
||||
Enable site search
|
||||
|
||||
```toml
|
||||
[params]
|
||||
enable_site_search = true # default: false
|
||||
```
|
||||
|
||||
## Syntax Highlighting
|
||||
|
||||
### Using Chroma (server-side)
|
||||
|
||||
See [Syntax Highlighting](https://gohugo.io/content-management/syntax-highlighting) for more details.
|
||||
|
||||
```toml
|
||||
[param]
|
||||
[param.syntax_highlight]
|
||||
lib = "builtin" # "builtin" | "prism.js" (default: "builtin")
|
||||
[param.syntax_highlight.builtin]
|
||||
enable_code_copy = true # default: true
|
||||
```
|
||||
|
||||
### Using Prism.js (client-side)
|
||||
|
||||
Disable markup highlight feature
|
||||
|
||||
```toml
|
||||
[markup.highlight]
|
||||
codeFences = false
|
||||
lineNos = false
|
||||
```
|
||||
|
||||
Enable Prism.js
|
||||
|
||||
```toml
|
||||
[param]
|
||||
[params.syntax_highlight]
|
||||
lib = "prism.js" # "builtin" | "prism.js" (default: "builtin")
|
||||
[params.syntax_highlight.prism]
|
||||
enable_code_copy = true # default: true
|
||||
enable_line_no = true # default: true
|
||||
```
|
||||
|
||||
## SEO
|
||||
|
||||
### Author
|
||||
|
||||
```toml
|
||||
[params]
|
||||
author = "kaiiiz" # default: no author `meta` tag
|
||||
```
|
||||
|
||||
### Open Graph
|
||||
|
||||
A flag to render open graph internal template. See [Open Graph](https://gohugo.io/templates/internal#open-graph) for additional settings.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
enable_open_graph = false # default: true
|
||||
```
|
||||
|
||||
### Twitter Cards
|
||||
|
||||
A flag to render open twitter cards template. See [Twitter Cards](https://gohugo.io/templates/internal#twitter-cards) for additional settings.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
enable_twitter_cards = false # default: true
|
||||
```
|
||||
|
||||
## Custom CSS
|
||||
|
||||
You can override the default styles by creating a new `/static/user.css` file.
|
||||
|
||||
## Default Color Scheme
|
||||
|
||||
You can set the default color scheme for your website
|
||||
|
||||
```toml
|
||||
[params]
|
||||
color_scheme = "dark" # "light" or "dark"
|
||||
```
|
||||
|
||||
> default: "light"
|
||||
|
||||
Reference in New Issue
Block a user