From 577d9b0fc0fb55f0992f04074c4d675fae262fc3 Mon Sep 17 00:00:00 2001 From: not-matthias <26800596+not-matthias@users.noreply.github.com> Date: Fri, 10 Jan 2025 19:55:25 +0100 Subject: [PATCH] chore: document search and js for toc --- content/posts/configuration.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/content/posts/configuration.md b/content/posts/configuration.md index 9f47bb7..7f99428 100644 --- a/content/posts/configuration.md +++ b/content/posts/configuration.md @@ -23,6 +23,18 @@ Enables or disables the search functionality for your blog. When enabled, a search index will be generated for your blog, allowing visitors to search for specific content. Additionally, a search button will be displayed in the navigation bar. +Configure the search like this: +```toml +build_search_index = true + +[search] +include_title = true +include_description = true +include_path = true +include_content = true +index_format = "elasticlunr_json" +``` + ## Theme Mode (`theme`) Sets the color theme for your blog. @@ -84,6 +96,8 @@ Enables or disables the table of contents for posts. When enabled, a table of contents will be generated for posts, making it easier for readers to navigate through longer articles. +Note: This feature adds additional JavaScript to your site. + ## CDN Usage (`use_cdn`) Determines whether to use a Content Delivery Network (CDN) for assets.