diff --git a/README.md b/README.md index 01b122e..7706d9b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,119 @@ A bootstrap theme for zola [Live Demo](https://marcodpt.github.io/zolastrap/) +## `config.toml` [extra] variables +### banner + - type: string + - default: "" +Path of a banner image, use empty string for no banner + +### date_format + - type: string + - default: "%d/%m/%Y" +date format expression + +### theme + - type: string + - default: "default" +one of the [Bootswatch](https://bootswatch.com) themes + +### bg + - type: string + - default: "dark" +one of the available backgrounds in +[Bootstrap5](https://getbootstrap.com/docs/5.1/utilities/background/) +for `navbar` and `footer` + +### inverted + - type: boolean + - default: false +Invert font for `navbar` and `footer` in case default choice is bad + +### themes + - type: string + - default: "Choose a Theme" +Navbar label for themes dropdown. + +This dropdown will allow user to change +[Bootswatch](https://bootswatch.com) theme. + +Use empty string in case you do not want the user choose a theme. + +### schemes + - type: string + - default: "Choose a Color Scheme" +Navbar label for schemes dropdown. + +This dropdown will allow user to change footer and navbar +[background](https://getbootstrap.com/docs/5.1/utilities/background/) +color. + +Use empty string in case you do not want the user choose a theme. + +### search + - type: string + - default: "Search" +Placeholder for navbar search input. + +Remember that to enable and disable search you should set variable +[build_search_index](https://www.getzola.org/documentation/getting-started/configuration/). + +### tag + - type: string + - default: "Posts by Topic" +Taxonomy `tag` single label. Useful for translations. + +### tags + - type: string + - default: "Posts by Topics" +Taxonomy `tag` list label. Useful for translations. +You can have a nice tag list at the bottom of a page using `extra.tags` = true +in the `_index.md` + +### links + - type: array + - default: [] +Navbar links. Use an empty array to ignore this. +Items (object): + - title (String): label of the navbar link + - url (String): href of associate link + +### email + - type: string + - default: "" +Footer email. Use an empty string to ignore this. + +### icons + - type: array + - default: [] +Footer social icons. Use an empty array to ignore this. +Items (object): + - title (string): Optional title string for icon + - icon (string): One of + - url (string): href of the icon + +### utterances + - type: string + - default: "" +[utterances](https://github.com/utterance/utterances) repo url. + +Use an empty string to ignore utterances widget. + +### utterances_label + - type: string + - default: "Comments" +[utterances](https://github.com/utterance/utterances) widget label. + +### utterances_theme + - type: string + - default: "github-light" +[utterances](https://github.com/utterance/utterances) widget theme. + +### utterances_issue_term + - type: string + - default: "pathname" +[utterances](https://github.com/utterance/utterances) widget pathname. + ## Contributing Any help is greatly appreciated! @@ -10,8 +123,3 @@ Any help is greatly appreciated! - [Zola SSG templates](https://www.getzola.org/documentation/templates/overview/) - [Bootstrap5 docs](https://getbootstrap.com/docs/5.1/getting-started/introduction/) - [Bootswatch](https://bootswatch.com) - -## TODO - - docs of all variables - - use it in small project - - make theme available diff --git a/config.toml b/config.toml index e53a059..9d1dcc3 100644 --- a/config.toml +++ b/config.toml @@ -18,30 +18,41 @@ build_search_index = true highlight_code = true [extra] -navbar = [ +banner = "img/banner.jpeg" +date_format = '%d/%m/%Y' + +theme = 'simplex' +bg = "dark" +inverted = false + +themes = "Choose a Theme" +schemes = "Choose a Color Scheme" +search = 'Search' +tag = 'Posts by Topic' +tags = 'Posts by Topics' + +links = [ {title = 'Articles', url = 'articles'}, {title = 'Authors', url = 'authors'}, {title = 'About', url = 'about'}, {title = 'Topics', url = 'tags'}, {title = 'Github', url = 'https://github.com/marcodpt/zolastrap'}, ] -date_format = '%d/%m/%Y' -search = 'Search' -theme = 'simplex' -tags = 'Posts by Topics' -social_icons = [ +email = "user@mail.com" +icons = [ {title = 'Facebook', icon = 'facebook-f', url = 'https://www.facebook.com'}, {title = 'Instagram', icon = 'instagram', url = 'https://www.instagram.com'}, {title = 'Twitter', icon = 'twitter', url = 'https://twitter.com'}, {title = 'YouTube', icon = 'youtube', url = 'https://www.youtube.com'} ] -email = "user@mail.com" -banner = "img/banner.jpeg" -footer_bg = "dark" -footer_font = "light" -navbar_bg = "dark" -navbar_type = "dark" -themes = [ + +utterances = "" +utterances_label = "Comments" +utterances_theme = "github-light" +utterances_issue_term = "pathname" + +# Do not change this variables +data_themes = [ 'default', 'cerulean', 'cosmo', @@ -69,19 +80,19 @@ themes = [ 'yeti', 'zephyr' ] -schemes = [ +data_schemes = [ 'dark', 'light', - 'primary dark', - 'primary light', - 'secondary dark', - 'secondary light', - 'success dark', - 'success light', - 'danger dark', - 'danger light', - 'warning dark', - 'warning light', - 'info dark', - 'info light', + 'primary', + 'primary inverted', + 'secondary', + 'secondary inverted', + 'success', + 'success inverted', + 'danger', + 'danger inverted', + 'warning', + 'warning inverted', + 'info', + 'info inverted', ] diff --git a/docs/about/index.html b/docs/about/index.html index 5dd945f..f584d3c 100644 --- a/docs/about/index.html +++ b/docs/about/index.html @@ -245,9 +245,14 @@ + + + + + @@ -261,6 +266,9 @@ + + +