mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-19 10:24:49 -04:00
Remove more extraneous config.toml values
This commit is contained in:
Ryan Watters
parent
a479cb136b
commit
1517384b9e
31
config.toml
31
config.toml
@ -4,17 +4,10 @@ buildFuture = false
|
||||
canonifyurls = true
|
||||
# Pointing to this file
|
||||
config = "config.toml"
|
||||
contentdir = "content"
|
||||
copyright = ""
|
||||
defaultContentLanguage = "en"
|
||||
# Set to true is you don't want livereload in local development
|
||||
disableLiveReload = false
|
||||
# Set to true to keep url path preserve casing (eg, for sections)
|
||||
disablePathToLower = false
|
||||
# Set to false if you want rss xml files auto-generated
|
||||
disableRSS = false
|
||||
# Set to false if you want a sitemap.xml created at the site root
|
||||
disableSitemap = false
|
||||
# Allows use of emoji shorthand directly in content
|
||||
enableEmoji = true
|
||||
# Set the unicode character used for the "return" link in page footnotes.
|
||||
@ -22,8 +15,6 @@ footnotereturnlinkcontents = "↩"
|
||||
# Create an array of files you don't want hugo to build
|
||||
ignoreFiles = []
|
||||
languageCode = "en-us"
|
||||
# Point the generator to the folder used for layouts and templating
|
||||
layoutDir = "layouts"
|
||||
# Enable Logging
|
||||
log = true
|
||||
# Log Filepath (if set, logging enabled automatically)
|
||||
@ -32,12 +23,7 @@ logFile = ""
|
||||
metaDataFormat = "yaml"
|
||||
# This intelligently adds an "s" to the titles of list pages
|
||||
pluralizelisttitles = false
|
||||
preserveTaxonomyNames = false
|
||||
# This sets the title of the directory where hugo builds and pushes the final site when running "Hugo" (ie, without "server")
|
||||
publishdir = "public"
|
||||
pygmentsUseClasses = true
|
||||
relativeURLs = true
|
||||
source = ""
|
||||
# Display memory and timing of different steps of the program
|
||||
stepAnalysis = true
|
||||
# This is the top-level, global site title
|
||||
@ -58,10 +44,9 @@ googleAnalytics = ""
|
||||
|
||||
#CUSTOM PARAMS
|
||||
[params]
|
||||
organizationname = ""
|
||||
sitedescription = ""
|
||||
## Used for views in rendered HTML (i.e., rather than using the .Hugo variable)
|
||||
release = "0.20"
|
||||
## Critical Render Path. If true, site style will be embedded in a <style> tag in each html <head> as part of Gulp Build. False puts a typical <link> to the stylesheet in <head>>
|
||||
## Critical Render Path. If true, site style will be embedded in a <style> tag in each html <head> as part of Gulp Build. False puts a typical <link> to the stylesheet in <head> See layouts/partials/style-embed.html
|
||||
usecrp = true
|
||||
## Twitter handle without the "@"
|
||||
twitterhandle = "GoHugoIO"
|
||||
@ -69,22 +54,21 @@ googleAnalytics = ""
|
||||
facebook = ""
|
||||
## Default Image for Social Sharing. This image should live at static/images/
|
||||
defaultsocialimage = "hugodefaultsocial.png"
|
||||
## Setting this to true will add a "noindex" to *every* page on the site
|
||||
## Setting this to true will add a "noindex" to *EVERY* page on the site
|
||||
removefromexternalsearch = false
|
||||
## This is used when the BaseURL does not need to modified (eg, in share links or in prerender, prefetch, etc to control for relativeURLs setting); do not include trailing slash
|
||||
## This is used when the BaseURL does not need to modified (eg, in share links or in prerender, prefetch, etc to control for relativeURLs setting); do *not* include trailing slash
|
||||
siteaddress = "https://hugodocs.info"
|
||||
## Gh repo for site footer (include trailing slash)
|
||||
ghrepo = "https://github.com/spf13/hugo/"
|
||||
## GitHub Docs Repository Base URL (include trailing slash)
|
||||
### https://github.com/spf13/hugo/tree/master/docs
|
||||
### Edit content repo (set to automatically enter "edit" mode => good for "improve this page" links)
|
||||
### Edit content repo (set to automatically enter "edit" mode; this is good for "improve this page" links)
|
||||
ghdocsrepo = "https://github.com/rdwatters/hugo-docs-concept/edit/master/"
|
||||
## Gitter URL
|
||||
gitter = "https://gitter.im/spf13/hugo"
|
||||
## Discuss Forum URL
|
||||
forum = "https://discuss.gohugo.io"
|
||||
## Google Tag Manager
|
||||
gtmid = ""
|
||||
# Set to true to include a CDN call to FontAwesome (not that Hugo docs currently hosts its own FA (see pipeline/scss/_variables.scss))
|
||||
# Set to true to include a CDN call to FontAwesome (note that Hugo currently hosts its own FA (see pipeline/scss/_variables.scss) if needed, but leverages a custom Fontello font or icons, including the "H" and "Gopher" icons for code blocks)
|
||||
usefontawesome = false
|
||||
|
||||
# MARKDOWN
|
||||
@ -95,6 +79,7 @@ googleAnalytics = ""
|
||||
angledQuotes = false
|
||||
latexDashes = true
|
||||
|
||||
## As of v0.20, all content files include a default "categories" value that's the same as the section. This was a cheap future-proofing method and should/could be changed accordingly.
|
||||
[taxonomies]
|
||||
tag = "tags"
|
||||
category = ""
|
||||
|
||||
@ -6,7 +6,7 @@ date: 2016-02-01
|
||||
publishdate: 2016-02-01
|
||||
lastmod: 2016-03-02
|
||||
categories: ["about hugo"]
|
||||
tags: ["license","apache"]
|
||||
tags: ["License","apache"]
|
||||
weight: 60
|
||||
aliases: [/meta/license]
|
||||
toc: true
|
||||
|
||||
@ -86,12 +86,18 @@ Moonrise Kingdom <- Content
|
||||
|
||||
Hugo natively supports taxonomies, which means there are architectural patterns for rendering your project's taxonomies baked into Hugo's core.
|
||||
|
||||
<!-- See conversation between bep and rdwatters here: https://github.com/spf13/hugo/issues/3165 && https://github.com/spf13/hugo/issues/2977-->
|
||||
<!-- Luckily, Hugo limits these default behaviors to those that fit the most common use cases in an effort to save you time. -->
|
||||
{{% note %}}
|
||||
Users of versions older than v0.20 may notice that Hugo built `/tags` and `/categories` as long as these fields were called in at least a single content file. A previous hack involved setting these values to empty strings. This is *not* a proper workaround.
|
||||
|
||||
<!-- ### Default Taxonomies
|
||||
As of v0.20, Hugo does *not* automatically generate default taxonomies for your site. If your site configuration contains no key-values in the taxonomies field, Hugo will not build anything.
|
||||
{{% /note %}}
|
||||
|
||||
Hugo ships with *tags* and *categories* as default taxonomies. These taxonomies are common to many website systems (e.g., WordPress, Drupal, Jekyll). Unlike these systems, Hugo makes it trivial to customize the taxonomies you will be using for your website. -->
|
||||
### Default Destinations
|
||||
|
||||
When taxonomies are used---and [taxonomy templates][] are provided---Hugo will automatically create both a page listing all the taxonomy's terms and individual pages with lists of content associated with each term. For example, a `categories` taxonomy declared in your your configuration and used in your content front matter will create the following pages:
|
||||
|
||||
* A single page at `yoursite.com/categories/` that lists all the [terms within the taxonomy][]
|
||||
* [Individual taxonomy list pages][taxonomy templates] (e.g., `/categories/development/`) for each of the terms that shows a listing of all pages marked as part of that taxonomy within any content file's [front matter][]
|
||||
|
||||
## Configuring Taxonomies
|
||||
|
||||
@ -115,30 +121,6 @@ taxonomies:
|
||||
series: "series"
|
||||
```
|
||||
|
||||
### Default Destinations
|
||||
|
||||
When taxonomies are used---and [taxonomy templates][] are provided---Hugo will automatically create both a page listing all the taxonomy's terms and individual pages with lists of content associated with each term. For example, a `categories` taxonomy will create the following pages:
|
||||
|
||||
* A single page at `yoursite.com/categories/` that lists all the [terms within the taxonomy][taxonomy terms templates]
|
||||
* [Individual taxonomy list pages][taxonomy templates] (e.g., `/categories/development/`) for each of the terms that shows a listing of all pages marked as part of that taxonomy within any content file's [front matter][]
|
||||
|
||||
<!-- See conversation between bep and rdwatters here: https://github.com/spf13/hugo/issues/3165 && https://github.com/spf13/hugo/issues/2977-->
|
||||
<!-- ### Overriding Hugo's Default Taxonomies
|
||||
|
||||
If you do not specify any taxonomies in your site configuration file *and* your content already includes front matter with `tags:` or `categories`, Hugo will automatically create taxonomy pages. To override this behavior, set the key-value pairs for both of the default taxonomies to empty strings in your `config` file:
|
||||
|
||||
```toml
|
||||
[taxonomies]
|
||||
tag = ""
|
||||
category = ""
|
||||
```
|
||||
|
||||
```yaml
|
||||
taxonomies:
|
||||
tag: ""
|
||||
category: ""
|
||||
``` -->
|
||||
|
||||
### Preserving Taxonomy Values
|
||||
|
||||
By default, taxonomy names are hyphenated, lower-cased, normalized, and then fixed and title-ized within.
|
||||
@ -254,5 +236,5 @@ Currently taxonomies only support the [default `weight => date` ordering of list
|
||||
[front matter]: /content-management/front-matter/
|
||||
[taxonomy list templates]: /templates/taxonomy-templates/#taxonomy-page-templates
|
||||
[taxonomy templates]: /templates/taxonomy-templates/
|
||||
[taxonomy terms templates]: /templates/taxonomy-templates/#taxonomy-terms-templates "See how to order terms associated with a taxonomy"
|
||||
[terms within the taxonomy]: /templates/taxonomy-templates/#taxonomy-terms-templates "See how to order terms associated with a taxonomy"
|
||||
[config]: /getting-started/configuration/
|
||||
@ -63,7 +63,7 @@ buildDrafts: false
|
||||
buildFuture: false
|
||||
# include content already expired
|
||||
buildExpired: false
|
||||
# enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs.
|
||||
# enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. See the "URL Management" page
|
||||
relativeURLs: false
|
||||
canonifyURLs: false
|
||||
# config file (default is path/config.yaml|json|toml)
|
||||
@ -378,7 +378,7 @@ blackfriday:
|
||||
* [YAML Spec][yaml]
|
||||
* [JSON Spec][json]
|
||||
|
||||
[`.Site.Params`]: /variables/
|
||||
[`.Site.Params`]: /variables/site/
|
||||
[dirs]: /getting-started/directory-structure
|
||||
[json]: /documents/ecma-404-json-spec.pdf
|
||||
[templates]: /templates/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user