README.adoc

BlogSearch index building tool for Jekyll

🔥	This is a part of BlogSearch project. If you would like to know the overall concept, go to the parent directory.

1. Building a search index file

Installation

Gemfile

group :jekyll_plugins do
  gem 'jekyll-blogsearch'

  ...
  Other jekyll plugins
  ...
end

Configuration

🔥	Go to the "What’s in the index file" section of the main project. For more details on how to configure fields.

_config.yml

titie: your-blog-website
email: [email protected]

url: "https://your-website"
baseurl: "/blog"

...
Other jekyll config
...

blogsearch:
  output: your_website_index.db.wasm # Generated blogsearch database file.
  fields: # See: https://github.com/kbumsik/blogsearch#whats-in-the-index
    title:
      enabled: true
      indexed: true
      hasContent: true
    body:
      enabled: true
      indexed: true
      hasContent: true
    url:
      base: https://your-website/blog # url field has a special 'base' option to set the baseurl.
      enabled: true
      indexed: false
      hasContent: true
    categories:
      enabled: true
      indexed: true
      hasContent: true
    tags:
      enabled: false
      indexed: false
      hasContent: false

2. Enabling the search engine in the webpage

You need to enable the search engine in the web page. Go to blogsearch Engine.

Again, if you would like to understand the concept of BlogSearch, go to the parent directory.