diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 9e320fc061..ce78d974bf 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -19,20 +19,48 @@ themesdir = "../.." disableLandingPageButton = true disableMermaid = false titleSeparator = "::" - themeVariant = "relearn" + themeVariant = "relearn-light" disableSeoHiddenPages = true [outputs] - home = ["HTML", "RSS", "JSON"] # add JSON to the home page to support lunr search + # add JSON to the home page to support lunr search; This is a mandatory setting + # for the search functionality + home = ["HTML", "RSS", "JSON"] [markup] [markup.highlight] - style = "tango" # choose a color theme or create your own - guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore + # if set to `guessSyntax = true`, there will be no unstyled code even if no language + # was given BUT mermaid code fences will not work anymore! So this is a mandatory + # setting for your site + guessSyntax = false -[markup.goldmark.renderer] - unsafe= true + # here in this showcase we use our own modified chroma syntax highlightning style + # which is imported in theme-relearn-light.css / theme-relearn-dark.css; + # if you want to use a predefined style instead: + # - remove the following `noClasses` + # - set the following `style` to a predefined style name + # - remove the `@import` of the self-defined chroma stylesheet from your CSS files + # (here eg.: theme-relearn-light.css / theme-relearn-dark.css) + noClasses = false + # style = "base16-snazzy" + [markup.goldmark.renderer] + # activated for this showcase to use HTML and JavaScript; decide on your own needs; + # if in doubt, remove this line + unsafe = true + +# allows `hugo server` to display this showcase in IE11; this is used for testing, as we +# are still supporting IE11 - although with degraded experience; if you don't care about +# `hugo server` or browsers of ancient times, fell free to remove this whole block +[server] + [[server.headers]] + for = "**.html" + [server.headers.values] + X-UA-Compatible = "IE=edge" + +# showcase of the menu shortcuts; you can use relative URLs linking +# to your content or use fully-quallified URLs to link outside of +# your project [Languages] [Languages.en] title = "Documentation for Hugo Relearn Theme" @@ -68,6 +96,11 @@ themesdir = "../.." url = "tags/" weight = 40 + # this ourrr way t' showcase th' multilang settings by + # doing autotrrranlat'n of th' english content; we are + # lazy and don't supporrt furrrther trrranslations; arrr, + # don't take it t' serrrious, fello'; it's prrretty hacky and: + # NOT MEANT FOR PRRRODUCTION! ARRR! [Languages.pir] title = "Documentat'n fer Cap'n Hugo Relearrrn Theme" weight = 1 diff --git a/exampleSite/content/basics/customization/_index.en.md b/exampleSite/content/basics/customization/_index.en.md index 39eddc5921..e148e86306 100644 --- a/exampleSite/content/basics/customization/_index.en.md +++ b/exampleSite/content/basics/customization/_index.en.md @@ -95,35 +95,41 @@ First, create a new CSS file in your local `static/css` folder prefixed by `them ```css :root { - --MAIN-TEXT-color: #323232; /* Color of text by default */ - --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5-h6 */ - --MAIN-LINK-color: #1C90F3; /* Color of links */ - --MAIN-LINK-HOVER-color: #167ad0; /* Color of hovered links */ - --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */ + --MAIN-TEXT-color: #101010; /* Color of text by default */ + --MAIN-TITLES-TEXT-color: #444753; /* Color of titles h2-h3-h4-h5-h6 */ + --MAIN-LINK-color: #486ac9; /* Color of links */ + --MAIN-LINK-HOVER-color: #134fbf; /* Color of hovered links */ + --MAIN-ANCHOR-color: #486ac9; /* color of anchors on titles */ + --MAIN-BG-color: #ffffff; /* color of text by default */ - /* adjusted to monokai chroma style */ - --MAIN-CODE-color: #e2e4e5; /* fallback color for code text */ - --MAIN-CODE-BG-color: #282a36; /* fallback color for code background */ + /* adjusted to relearn-light chroma style */ + --CODE-BLOCK-color: #000000; /* fallback color for block code text */ + --CODE-BLOCK-BG-color: #f8f8f8; /* fallback color for block code background */ + --CODE-BLOCK-BORDER-color: #d8d8d8; /* color of block code border */ + + --CODE-INLINE-color: #5e5e5e; /* color for inline code text */ + --CODE-INLINE-BG-color: #fffae9; /* color for inline code background */ + --CODE-INLINE-BORDER-color: #f8e8c8; /* color of inline code border */ --MENU-HOME-LINK-color: #323232; /* Color of the home button text */ - --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color of the hovered home button text */ + --MENU-HOME-LINK-HOVER-color: #808080; /* Color of the hovered home button text */ - --MENU-HEADER-BG-color: #1C90F3; /* Background color of menu header */ - --MENU-HEADER-BORDER-color: #33a1ff; /*Color of menu header border */ + --MENU-HEADER-BG-color: #7dc903; /* Background color of menu header */ + --MENU-HEADER-BORDER-color: #7dc903; /*Color of menu header border */ - --MENU-SEARCH-BG-color: #167ad0; /* Search field background color (by default borders + icons) */ - --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */ - --MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */ + --MENU-SEARCH-color: #efefef; /* Color of search field text */ + --MENU-SEARCH-BG-color: #3d414d; /* Search field background color (by default borders + icons) */ + --MENU-SEARCH-BOX-color: #efefef; /* Override search field border color */ - --MENU-SECTIONS-ACTIVE-BG-color: #20272b; /* Background color of the active section and its children */ - --MENU-SECTIONS-BG-color: #252c31; /* Background color of other sections */ - --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ - --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ - --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ - --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ + --MENU-SECTIONS-ACTIVE-BG-color: #202028; /* Background color of the active section and its children */ + --MENU-SECTIONS-BG-color: #282830; /* Background color of other sections */ + --MENU-SECTIONS-LINK-color: #bababa; /* Color of links in menu */ + --MENU-SECTIONS-LINK-HOVER-color: #ffffff; /* Color of links in menu, when hovered */ + --MENU-SECTION-ACTIVE-CATEGORY-color: #444444; /* Color of active category text */ + --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #ffffff; /* Color of background for the active category (only) */ - --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */ - --MENU-SECTION-HR-color: #20272b; /* Color of