nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-30 11:13:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hugo-theme-relearn/exampleSite/content/basics/configuration/_index.en.md

61 lines
2.6 KiB
Markdown
Raw Normal View History

add first content for new documentation
2017-08-16 22:57:44 +00:00
---
date: 2016-04-09T16:50:16+02:00
title: Configuration
weight: 20
---
## Global site parameters
On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** lets you define the following parameters in your `config.toml` (here, values are default).
Note that some of these parameters are explained in details in other sections of this documentation.
```toml
[params]
Allow custom css files to be loaded by configuration Previously adding custom css files would require the end user to copy the header or footer partial into their overrides. They would then need to maintain that partial into the future. This config allows a user to provide a list of custom css files to load into the theme, meaning they do not need to clone the partial. ``` [params] custom_css = ["css/foo.css", "css/bar.css"] ``` Inspiration taken from https://discourse.gohugo.io/t/how-to-override-css-classes-with-hugo/3033/4
2020-03-09 15:50:24 +00:00
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
add first content for new documentation
2017-08-16 22:57:44 +00:00
# Useful to give opportunity to people to create merge request for your doc.
# See the config.toml file from this documentation site to have an example.
editURL = ""
# Author of the site, will be used in meta information
author = ""
# Description of the site, will be used in meta information
description = ""
# Shows a checkmark for visited pages on the menu
showVisitedLinks = false
# Disable search function. It will hide search bar
disableSearch = false
Allow custom css files to be loaded by configuration Previously adding custom css files would require the end user to copy the header or footer partial into their overrides. They would then need to maintain that partial into the future. This config allows a user to provide a list of custom css files to load into the theme, meaning they do not need to clone the partial. ``` [params] custom_css = ["css/foo.css", "css/bar.css"] ``` Inspiration taken from https://discourse.gohugo.io/t/how-to-override-css-classes-with-hugo/3033/4
2020-03-09 15:50:24 +00:00
# Javascript and CSS cache are automatically busted when new version of site is generated.
add first content for new documentation
2017-08-16 22:57:44 +00:00
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
disableAssetsBusting = false
# Set this to true to disable copy-to-clipboard button for inline code.
disableInlineCopyToClipBoard = false
Allow custom css files to be loaded by configuration Previously adding custom css files would require the end user to copy the header or footer partial into their overrides. They would then need to maintain that partial into the future. This config allows a user to provide a list of custom css files to load into the theme, meaning they do not need to clone the partial. ``` [params] custom_css = ["css/foo.css", "css/bar.css"] ``` Inspiration taken from https://discourse.gohugo.io/t/how-to-override-css-classes-with-hugo/3033/4
2020-03-09 15:50:24 +00:00
# A title for shortcuts in menu is set by default. Set this to true to disable it.
add first content for new documentation
2017-08-16 22:57:44 +00:00
disableShortcutsTitle = false
add english documentation content
2017-08-20 15:10:29 +00:00
# When using mulitlingual website, disable the switch language button.
disableLanguageSwitchingButton = false
Add disableBreadcrumbs and disableNextPrev to English documentation
2018-10-23 02:57:19 +00:00
# Hide breadcrumbs in the header and only show the current page title
disableBreadcrumb = true
# Hide Next and Previous page buttons normally displayed full height beside content
disableNextPrev = true
add first content for new documentation
2017-08-16 22:57:44 +00:00
# Order sections in menu by "weight" or "title". Default to "weight"
ordersectionsby = "weight"
# Change default color scheme with a variant one. Can be "red", "blue", "green".
themeVariant = ""
Allow custom css files to be loaded by configuration Previously adding custom css files would require the end user to copy the header or footer partial into their overrides. They would then need to maintain that partial into the future. This config allows a user to provide a list of custom css files to load into the theme, meaning they do not need to clone the partial. ``` [params] custom_css = ["css/foo.css", "css/bar.css"] ``` Inspiration taken from https://discourse.gohugo.io/t/how-to-override-css-classes-with-hugo/3033/4
2020-03-09 15:50:24 +00:00
# Provide a list of custom css files to load relative from the `static/` folder in the site root.
custom_css = ["css/foo.css", "css/bar.css"]
add first content for new documentation
2017-08-16 22:57:44 +00:00
```
## Activate search
If not already present, add the follow lines in the same `config.toml` file.
```toml
[outputs]
home = [ "HTML", "RSS", "JSON"]
```
Learn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
Allow custom css files to be loaded by configuration Previously adding custom css files would require the end user to copy the header or footer partial into their overrides. They would then need to maintain that partial into the future. This config allows a user to provide a list of custom css files to load into the theme, meaning they do not need to clone the partial. ``` [params] custom_css = ["css/foo.css", "css/bar.css"] ``` Inspiration taken from https://discourse.gohugo.io/t/how-to-override-css-classes-with-hugo/3033/4
2020-03-09 15:50:24 +00:00
> Hugo generate lunrjs index.json at the root of public folder.
Update _index.en.md
2018-01-28 09:54:02 +00:00
> When you build the site with `hugo server`, hugo generates it internally and of course it doesn’t show up in the filesystem
Reference in a new issue Copy permalink