diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 32 insertions, 1 deletions
diff --git a/README.md b/README.md index db77233..bab2a89 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ ## Demo -For a current & working demo of this theme, please check out <https://zola-bearblog.netlify.app/> 🎯. +This theme has multiple demo sites, to provide examples of how to set up deployment +- [Vercel](https://zola-bearblog.vercel.app/) +- [Netlify](https://zola-bearblog.netlify.app/) +- [Gitlab Pages](https://alanpearce.gitlab.io/zola-bearblog) +- [Cloudflare Pages](https://zola-bearblog.pages.dev/) ## Screenshot @@ -46,6 +50,10 @@ Create an array in `extra` with a key of `main_menu`. `url` is passed to [`get_u ```toml [[extra.main_menu]] +name = "Home" +url = "@/_index.md" + +[[extra.main_menu]] name = "Bear" url = "@/bear.md" @@ -69,6 +77,29 @@ The contents of the `index`-page may be changed by editing your `content/_index. Add a `custom_head.html`-file to your `templates/`-directory. In there you may add a `<style>`-tag, *or* you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Check out the [`style.html`](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/templates/style.html)-file to find out which CSS-styles are applied by default. +### Table of contents + +Table of contents are not rendered by default. To render them, set `extra.table_of_contents.show = true` in `config.toml`. + +The table of contents is rendered inside a `details` element. +If you want the section to be collapsed on page load, set `extra.table_of_contents.visible_on_load = false`. +This defaults to `true`. + +In addition, `extra.table_of_contents.max_level` can limit the maximum level of headers to show. +To show only `h1`s, set `max_level = 1`, to show `h1`s and `h2`s, set `max_level = 2`, and so on. +By default, `max_level` is set to 6, so all headers on the page are shown. + +Below is an example of how to configure the table of contents in `config.toml`. + +```toml +[extra.table_of_contents] +show = true +max_level = 2 +visible_on_load = false +``` + +It can also be toggled on page-by-page basis. Add `extra.hide_table_of_contents = true` to the page's frontmatter to hide the table of contents for that specific page. + ## Issues / Feedback / Contributing Please use [Codeberg issues](https://codeberg.org/alanpearce/zola-bearblog/issues) and [Pull Requests](https://codeberg.org/alanpearce/zola-bearblog/pulls). |