เพิ่มปุ่ม Search ให้กับ Static Website + แชร์วิธีการทำ

จริงๆแล้วบทความนี้แค่จะมาอัพเดทเพื่อบอกว่าตอนนี DevAhoy สามารถทำการค้นหาบทความได้แล้วนะครับ :)

เนื่องมาจากหลายๆคนสอบถามเข้ามาว่า ทำไมบล็อกไม่ทำปุ่ม search ละ? เวลาจะค้นหาอะไรก็ต้องเข้า google แล้วพิมพ์ “devahoy + keyword” ซึ่งมันไม่สะดวกเท่าไหร่

เมื่อพิจารณาดูแล้ว เนื่องจากว่าบล็อกนี้ เป็น Static Website ไม่มีฐานข้อมูล ฉะนั้น ทางเลือกที่เป็นไปได้ในการเพิ่มปุ่ม Search ก็มี 2 ทางเลือก คือ

1. Middleman Search + lunr.js
2. Google Custom Search
3. Algolia Search

แต่ว่าเลือกใช้ข้อ 1 และตัด Google Custom Search ออกเนื่องจากว่ามันเหมือน google ทั่วไป ไปค้นหาใน google น่าจะดูดีกว่า ส่วนข้อ 3 Algolia Search ดูน่าสนใจดีแต่ว่าไม่มี plugin สำหรับ Middleman มีแต่ Jekyll ก็เลยเลือกใช้ middleman-search ดีกว่า

ซึ่งตอนนี้ก็มีปุ่มค้นหาแล้ว ต่อไปก็จะมาแชร์วิธีการทำ เผื่อว่าจะมีคนที่ใช้ static website แล้วอยากมีปุ่มค้นหาบ้าง

Installation

เปิด Gemfile และทำการเพิ่ม https://github.com/manastech/middleman-search ลงไป

1
gem 'middleman-search'

สั่ง install gem

1
bundle

จากนั้นแก้ไขไฟล์ config.rb โดยเพิ่มส่วนที่เราจะตั้งค่าตัว search

1
activate :search do |search|
2
  search.resources = ['posts/', 'index.html']
3
  search.index_path = 'search/index.json'
4
  search.fields = {
5
    title: { boost: 100, store: true, required: true },
6
    content: { boost: 60 },
7
    url: { boost: 80, index: false, store: true }
8
  }
9
end

อธิบายเพิ่มเพิม

• resources คือ list ของ url ที่ต้องการจะให้มัน index
• index_path คือ path สำหรับไฟล์ json ที่ตัว lunr มัน generate มาให้
• fields คือ ค่าไหนบ้างที่ต้องให้เอาไปค้นหา

Implement Code

เพิ่มปุ้นค้นหาที่หน้าเว็บลงไป

1
<div class="search-input">
2
  <input type="text" id="search-box" placeholder="Search..." />
3
  <button id="btn-search">
4
    <i class="fa fa-search" aria-hidden="true"></i>
5
  </button>
6
</div>

ทีนี้เมื่อเราทำการค้นหา ก็จะไปทำการค้นหาข้อมูลจากไฟล์ json ที่ lunr มันทำ index ไว้ให้

1
//= require lunr.min
2

3
var lunrIndex = null
4
var lunrData = null
5
var results = ''
6

7
$('#btn-search').on('click', function () {
8
  var query = $('#search-box').val()
9

10
  $.ajax({
11
    url: '/search/index.json',
12
    cache: true,
13
    method: 'GET',
14
    success: function (data) {
15
      lunrData = data
16
      lunrIndex = lunr.Index.load(lunrData.index)
17

18
      results = lunrIndex.search(query)
19

20
      results.map(function (result) {
21
        var post = lunrData.docs[result.ref]
22
        var title = post.title
23
        var url = post.url
24

25
        $('#search-list ul').append('<li><a href="' + url + '">' + title + '</a></li>')
26
      })
27
    }
28
  })
29
})

ตัวอย่างโค๊ดด้านบน ก็เป็นตัวอย่างง่ายๆ เมื่อเรากดคลิกปุ่ม Search ก็ใช้ jquery ajax ทำการยิง GET ไปที่ไฟล์ /search/index.json (ที่เดียวกับที่ตั้งค่าไว้ใน config.rb ) เพื่อทำการโหลด json มา จากนั้นตัว lunr จะ search query กับ index เพื่อหาค่าผลลัพธ์ที่ได้

พอได้ผลลัพธ์แล้ว ก็จะนำค่า result.ref ไปแมพกับ lunr.docs ซึ่งเป็น object ที่เก็บชื่อ title, url ของบทความเรานั่นเอง

สุดท้ายก็ได้หน้าตา search ง่ายๆ บนเว็บแล้ว

สรุป

ถึงแม้ว่าจะมีปุ่มค้นหาแล้วก็ตาม แต่ว่ายังมีข้อจำกัดหลายๆด้าน ไม่ว่าจะเป็น เรื่องความเร็วในการค้นหา อาจจะสู้ Google Custom Search ไม่ได้ และตอนนี้ก็สามารถค้นหาได้แต่ภาษาอังกฤษเท่านั้น เนื่องจากว่า lunr.js i18n นั้นยังไม่รองรับภาษาไทยนั่นเอง

ส่วนตัว Google Custom Search นั้น implement ง่ายมาก และค้นหาได้เร็วกว่า แต่รู้สึกว่าขี้เกียจมานั่งปรับแต่ง style ซึ่งหากว่า middleman search ณ ตอนนี้ไม่เวิร์คเท่าไหร่ ก็อาจจะลองใช้ Google Custom Search ดูก็ได้