From 55ee142cb671778f19e9636ff3c7fe30b8e2f47f Mon Sep 17 00:00:00 2001 From: Marcell Mars Date: Wed, 28 Apr 2021 21:00:39 +0200 Subject: [PATCH] added few comments to config template in exampleSite --- exampleSite/config.toml | 154 +++++++++++++++++++++------------------- 1 file changed, 80 insertions(+), 74 deletions(-) diff --git a/exampleSite/config.toml b/exampleSite/config.toml index e34b2fc..2ff8b66 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -5,95 +5,101 @@ relativeurls = true disableKinds = ["RSS", "sitemap"] # journals probably should have at least keyword = "keywords" +# # [taxonomies] # keyword = "keywords" [params] - 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 = "https://git.sandpoints.org/Drawwell/SimpleSandpoints" +description = "This is an example description in Sandpoints Theme's example config file." - # sandpointsCatalogPrefix is used in custom bib: links impplemented in render-image.html - # sandpointsCatalogPrefix = "hyper://18f79903cb7ce4f1f3c05449418505a296bb2c4e851f7dc9444cf87ed45fb194/" - # sandpointsCatalogName will be symlink to library following the path: - # /var/www/html/sandpoints/libraris/{sandpointsCatalogName} - # sandpointsCatalogName = "dotawo" +## sandpointsGiteaUrl is used in layouts/partials/header.html to generate links in admin ui bar +# +# sandpointsGiteaUrl = "https://git.sandpoints.org/Drawwell/SimpleSandpoints" + +## sandpointsCatalogPrefix is used in custom bib: links impplemented in render-image.html +# +# sandpointsCatalogPrefix = "hyper://18f79903cb7ce4f1f3c05449418505a296bb2c4e851f7dc9444cf87ed45fb194/" + +## sandpointsCatalogName will be symlink to library following the path: +## /var/www/html/sandpoints/libraries/{sandpointsCatalogName} +# +# sandpointsCatalogName = "dotawo" [outputFormats] - [outputFormats.js] - isPlainText = true - mediaType = "application/javascript" +[outputFormats.js] +isPlainText = true +mediaType = "application/javascript" [outputs] - list = ["html", "js"] +list = ["html", "js"] [markup.tableOfContents] - endLevel=4 - ordered = true - startLevel = 1 +endLevel=4 +ordered = true +startLevel = 1 [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] - # 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"] +## 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"] - # if any customizations are added one should add also - # the hugo's skeleton directory structure: - # archetypes, assets, layouts, static & data - # - [[module.imports]] - path = "git.sandpoints.org/Drawwell/SandpointsTheme" - [[module.imports.mounts]] - source = "archetypes" - target = "archetypes" - [[module.imports.mounts]] - source = "assets" - target = "assets" - [[module.imports.mounts]] - source = "layouts" - target = "layouts" - [[module.imports.mounts]] - source = "static" - target = "static" - [[module.imports.mounts]] - source = "data" - target = "data" - - # metadata file needed for autocompletion - # - [[module.imports.mounts]] - source = "exampleSite/content/metadata/_index.md" - target = "content/metadata/_index.md" +## 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 +# +[[module.imports]] +path = "git.sandpoints.org/Drawwell/SandpointsTheme" +[[module.imports.mounts]] +source = "archetypes" +target = "archetypes" +[[module.imports.mounts]] +source = "assets" +target = "assets" +[[module.imports.mounts]] +source = "layouts" +target = "layouts" +[[module.imports.mounts]] +source = "static" +target = "static" +[[module.imports.mounts]] +source = "data" +target = "data" - # below is an example of customizations added to hugo web site - # - # [[module.imports.mounts]] - # source = "customizations/Dotawo/assets/css/site.css" - # target = "assets/css/site.css" - # [[module.imports.mounts]] - # source = "customizations/Dotawo/static/css/site.min.css" - # target = "static/css/site.min.css" +## import _index.md from SandpointsTheme exampleSite to content/metadata so the metadata is rendered without bothering the regular user +# +[[module.imports.mounts]] +source = "exampleSite/content/metadata/_index.md" +target = "content/metadata/_index.md" - # below is the list of imports to get the svelte webapp - # which handles editing the website - # - [[module.imports]] - path = "git.sandpoints.org/Drawwell/SandpointsEditPage" - [[module.imports.mounts]] - source = "public/index.md" - target = "content/edit/index.md" - [[module.imports.mounts]] - source = "public/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]] - source = "public/build/bundle.js" - target = "static/edit/build/bundle.js" - [[module.imports.mounts]] - source = "public/build/bundle.js.map" - target = "static/edit/build/bundle.js.map" +## below is the example of custom css imported from customizations directory of Dotawo project +# +# [[module.imports.mounts]] +# source = "customizations/Dotawo/assets/css/site.css" +# target = "assets/css/site.css" +# [[module.imports.mounts]] +# source = "customizations/Dotawo/static/css/site.min.css" +# target = "static/css/site.min.css" + +# below is the list of imports to get the svelte webapp +# which handles editing the website +# +[[module.imports]] +path = "git.sandpoints.org/Drawwell/SandpointsEditPage" +[[module.imports.mounts]] +source = "public/index.md" +target = "content/edit/index.md" +[[module.imports.mounts]] +source = "public/global.css" +target = "static/edit/build/global.css" +[[module.imports.mounts]] +source = "public/build/bundle.js" +target = "static/edit/build/bundle.js" +[[module.imports.mounts]] +source = "public/build/bundle.js.map" +target = "static/edit/build/bundle.js.map"