หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

- จิตใจ

Psyche เป็นโซลูชันแบบเลื่อนลงสำหรับการค้นหาเอกสารซึ่งได้รับแรงบันดาลใจจากเอกสารการค้นหาของ Algolia

  • มัน ดูและรู้สึกยอดเยี่ยม ที่จะใช้
  • การค้นหานั้น รวดเร็วแม่นยำและทนทาน
  • สามารถรวมอยู่ในเว็บไซต์เอกสาร ที่สร้างขึ้นหรือสร้างเซิร์ฟเวอร์
  • มันเพิ่มเป็นสองเท่าเป็น แผนผังไซต์คีย์บอร์ด-navigable
  • มันทำให้การลงทะเบียน ฮอตคีย์ขึ้นอยู่กับแพลตฟอร์มทั่วทั้งไซต์
  • เป็น มิตรกับมือถือ
  • รองรับทั้ง โหมดแสงและมืด

ตรวจสอบเอกสารประกอบความคิดสำหรับการสาธิตสด

คำเตือน: Psyche ถูกสร้างขึ้นโดยเฉพาะสำหรับการค้นหาเอกสาร มันไม่ได้ถูกสร้างขึ้นสำหรับการใช้งานในอินเทอร์เฟซอื่น ๆ (เช่นอีคอมเมิร์ซ) หรือใช้กับแผนการข้อมูลที่กำหนดเอง

เริ่มต้น

สร้างดัชนี

ไคลเอนต์ Psyche ต้องการดัชนีผลลัพธ์ที่สร้างไว้ล่วงหน้าเพื่อค้นหา นี่ควรเป็นอาร์เรย์ของบันทึก Result (ดู types.d.ts) ดัชนีมีให้กับลูกค้าโดยทางโปรแกรม แต่ควรใช้รูปแบบของไฟล์. .json ที่ไม่ได้ฟอร์ม/minified

ดัชนีคือปลั๊กอิน/มิดเดิลแวร์ที่รวบรวมข้อมูลไซต์และสร้างดัชนีไม่ว่าจะเป็นในระหว่างกระบวนการสร้างหรือการบินหากไซต์เสิร์ฟแบบไดนามิก

ดัชนีสำหรับเครื่องกำเนิดเอกสารบางตัวมีให้ด้านล่าง หากยังไม่รองรับเครื่องกำเนิดไฟฟ้าของคุณให้เปิดคำขอคุณลักษณะหรือเขียนของคุณเองและเปิดคำขอดึง

ร่อง

เพิ่มสิ่งต่อไปนี้ในไฟล์ _config.ts ของคุณ: 

 import psyche from 'https://deno.land/x/psyche/indexers/lume.ts' ;

site . use ( psyche ( ) ) ;

ตัวทำดัชนีสามารถกำหนดค่าได้โดยการจัดหาวัตถุ LumeConfig เป็นอาร์กิวเมนต์แรกของการโทร psyche() (ดู types.d.ts)

โดยค่าเริ่มต้น:

  • ดัชนีจะถูกส่งออกไปยัง /search.json
  • หน้าไม่มี data.section หรือที่ data.draft = true จะถูกละเว้น
  • หน้าจะถูกจัดกลุ่มโดย data.section_order & เรียงตาม data.order
  • ชื่อหน้าสามารถเข้าถึงได้จาก data.title
  • ส่วนหน้าสามารถเข้าถึงได้จาก data.section
  • ส่วนหัว, บล็อกรหัส, ย่อหน้าและรายการภายในองค์ประกอบ <article></article> ในหน้าจะถูกจัดทำดัชนีตามความหมาย HTML องค์ประกอบอื่น ๆ (เช่น <blockquote></blockquote> ) ได้รับการปฏิบัติเป็นย่อหน้า สิ่งนี้ใช้งานได้ดีที่สุดกับเอาต์พุต Markdown

อ่านข้อมูลหน้าและ/หรือหน้าข้อมูลที่ใช้ร่วมกันของเอกสารของ Lume เพื่อดูวิธีการตั้งค่าคุณสมบัติเหล่านี้

รวมถึงลูกค้า

ไคลเอ็นต์ Psyche เขียนด้วย TypeScript คุณสามารถนำเข้าโดยตรงหากสินทรัพย์ของไซต์ของคุณจะถูกรวมเข้าด้วยกันเช่น Esbuild หรือนำเข้า JavaScript Build และ Minified JavaScript 

 import psyche from 'https://deno.land/x/psyche/client/mod.ts' ;
// or
import psyche from 'https://deno.land/x/psyche/client/psyche.min.mjs' ;

การส่งออกเริ่มต้นของ psyche เป็นฟังก์ชั่นที่เมื่อให้มาพร้อมกับวัตถุ ClientConfig (ดู types.d.ts) จะส่งคืน ClientInstance (ดู types.d.ts)

การโทร .register() บนอินสแตนซ์ไคลเอ็นต์จะแทรกส่วนประกอบลงในเอกสารและฟังการกด Hotkey ส่วนประกอบสามารถเปิดได้โดยการโทร .open() หรือโดยการกด CTRL/⌘ + K

เช่น 

 const searchInstance = psyche ( {
  theme : { scrollbarStyle : 'square' } ,
  index : await fetch ( '/search.json' ) . then ( ( res ) => res . json ( ) ) ,
} ) ;
searchInstance . register ( ) ;
searchInstance . open ( ) ;

การลงทะเบียนคีย์

หากต้องการเพิ่มฮอตคีย์ลงในรายการในการค้นหาโมดัลให้เพิ่มลงในอาร์เรย์ hotkeys ของวัตถุ ClientConfig ของ Psyche (ดู Types.d.ts)

สำหรับคีย์ที่ขึ้นอยู่กับแพลตฟอร์มตัวส่งออก platformModifier ที่มีชื่อจะเทียบเท่ากับคีย์ ⌘ บน MacOS หรือคีย์ CTRL บนแพลตฟอร์มอื่น ๆ

ในการจัดการสายลัดจัดเตรียมวัตถุ ClientHotkey (ดู types.d.ts) ไปยังชื่อ Export registerHotkey ที่มีชื่อ นี่คือ KeyboardEvent บางส่วนที่มีคุณสมบัติเพิ่มเติมสองสาม:

  • คุณสมบัติ platformModifier เทียบเท่ากับ metaKey บน macOS หรือ ctrlKey บนแพลตฟอร์มอื่น ๆ
  • คุณสมบัติ onkeydown จะถูกเรียกเมื่อการรวมคีย์ถูกกดลงผ่าน KeyboardEvent ที่ถูกทริกเกอร์เป็นอาร์กิวเมนต์แรก
  • คุณสมบัติ onkeyup จะถูกเรียกเมื่อการรวมคีย์ถูกปล่อยออกมาผ่าน KeyboardEvent ที่ถูกทริกเกอร์เป็นอาร์กิวเมนต์แรก

เช่น 

 import psyche , {
  registerHotkey ,
  platformModifier ,
} from 'https://deno.land/x/psyche/client/psyche.min.mjs' ;

registerHotkey ( {
  key : 'l' ,
  platformModifier : true ,
  shiftKey : true ,
  onkeydown : ( event ) => {
    event . preventDefault ( ) ;
    toggleTheme ( ) ;
  } ,
} ) ;

const searchInstance = psyche ( {
  hotkeys : [ { kbd : ` ${ platformModifier } + SHIFT + L` , label : 'to toggle theme' } ] ,
} ) ;
searchInstance . register ( ) ;

การเปลี่ยนแปลงโครงการนี้จะถูกบันทึกไว้ในการเปลี่ยนแปลง

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT

เพื่อสนับสนุนการพัฒนาในอนาคตของโครงการนี้โปรดพิจารณาสนับสนุนผู้เขียน

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด