added few comments to config template in exampleSite

This commit is contained in:
Marcell Mars 2021-04-28 21:00:39 +02:00
parent ffcc939c4b
commit 55ee142cb6

View file

@ -5,18 +5,24 @@ relativeurls = true
disableKinds = ["RSS", "sitemap"] disableKinds = ["RSS", "sitemap"]
# journals probably should have at least keyword = "keywords" # journals probably should have at least keyword = "keywords"
#
# [taxonomies] # [taxonomies]
# keyword = "keywords" # keyword = "keywords"
[params] [params]
description = "This is an example description in Sandpoints Theme's example config file." description = "This is an example description in Sandpoints Theme's example config file."
# sandpointsGiteaUrl is used in layouts/partials/header.html to generate links in admin ui bar
## sandpointsGiteaUrl is used in layouts/partials/header.html to generate links in admin ui bar
#
# sandpointsGiteaUrl = "https://git.sandpoints.org/Drawwell/SimpleSandpoints" # sandpointsGiteaUrl = "https://git.sandpoints.org/Drawwell/SimpleSandpoints"
# sandpointsCatalogPrefix is used in custom bib: links impplemented in render-image.html ## sandpointsCatalogPrefix is used in custom bib: links impplemented in render-image.html
#
# sandpointsCatalogPrefix = "hyper://18f79903cb7ce4f1f3c05449418505a296bb2c4e851f7dc9444cf87ed45fb194/" # sandpointsCatalogPrefix = "hyper://18f79903cb7ce4f1f3c05449418505a296bb2c4e851f7dc9444cf87ed45fb194/"
# sandpointsCatalogName will be symlink to library following the path:
# /var/www/html/sandpoints/libraris/{sandpointsCatalogName} ## sandpointsCatalogName will be symlink to library following the path:
## /var/www/html/sandpoints/libraries/{sandpointsCatalogName}
#
# sandpointsCatalogName = "dotawo" # sandpointsCatalogName = "dotawo"
[outputFormats] [outputFormats]
@ -35,14 +41,17 @@ disableKinds = ["RSS", "sitemap"]
[markup.goldmark.renderer] [markup.goldmark.renderer]
unsafe = true unsafe = true
## Enable custom attribute support for titles and blocks by adding attribute lists inside single curly brackets ({.myclass class="class1 class2" }) and placing it after the Markdown element it decorates, on the same line for titles and on a new line directly below for blocks. introduced in hugo v0.81
#
[markup.goldmark.parser.attribute]
block = true
[module] [module]
# replacement allow for easier local development ## replacement allow for easier local development
# #
# replacements = ["git.sandpoints.org/Drawwell/SandpointsTheme -> /home/m/devel/SandpointsTheme", "git.sandpoints.org/Drawwell/SandpointsEditPage -> /home/m/devel/SandpointsEditPage"] # replacements = ["git.sandpoints.org/Drawwell/SandpointsTheme -> /home/m/devel/SandpointsTheme", "git.sandpoints.org/Drawwell/SandpointsEditPage -> /home/m/devel/SandpointsEditPage"]
# if any customizations are added one should add also ## if any customizations are added one should add, along with the customization imports, also the hugo's skeleton directory structure: archetypes, assets, layouts, static & data
# the hugo's skeleton directory structure:
# archetypes, assets, layouts, static & data
# #
[[module.imports]] [[module.imports]]
path = "git.sandpoints.org/Drawwell/SandpointsTheme" path = "git.sandpoints.org/Drawwell/SandpointsTheme"
@ -62,13 +71,13 @@ disableKinds = ["RSS", "sitemap"]
source = "data" source = "data"
target = "data" target = "data"
# metadata file needed for autocompletion ## import _index.md from SandpointsTheme exampleSite to content/metadata so the metadata is rendered without bothering the regular user
# #
[[module.imports.mounts]] [[module.imports.mounts]]
source = "exampleSite/content/metadata/_index.md" source = "exampleSite/content/metadata/_index.md"
target = "content/metadata/_index.md" target = "content/metadata/_index.md"
# below is an example of customizations added to hugo web site ## below is the example of custom css imported from customizations directory of Dotawo project
# #
# [[module.imports.mounts]] # [[module.imports.mounts]]
# source = "customizations/Dotawo/assets/css/site.css" # source = "customizations/Dotawo/assets/css/site.css"
@ -88,9 +97,6 @@ disableKinds = ["RSS", "sitemap"]
[[module.imports.mounts]] [[module.imports.mounts]]
source = "public/global.css" source = "public/global.css"
target = "static/edit/build/global.css" target = "static/edit/build/global.css"
[[module.imports.mounts]]
source = "public/build/bundle.css"
target = "static/edit/build/bundle.css"
[[module.imports.mounts]] [[module.imports.mounts]]
source = "public/build/bundle.js" source = "public/build/bundle.js"
target = "static/edit/build/bundle.js" target = "static/edit/build/bundle.js"