โค้ด ​

แทรกโค้ดหลายบรรทัดให้แยกจากเนื้อหาปกติ พิมพ์แบ็กทิกสามตัวในย่อหน้าว่างแล้วกด Space หรือ Enter หรือเปลี่ยนเป็นบล็อกโค้ดจากแถบเครื่องมือ หากเติมชื่อภาษาหลังแบ็กทิก เช่น ts ชื่อนั้นจะถูกเก็บไว้ด้วย

ชื่อภาษาเป็นตัวระบุที่ใช้สำหรับการเน้นไวยากรณ์ และยังพิมพ์ชื่อที่อยู่นอกบัญชีรายชื่อที่ลงทะเบียนได้เอง เนื่องจากต้องรักษาเนื้อหาโค้ดและการเยื้อง บล็อกโค้ดจึงไม่ใช้การจัดแนวย่อหน้า

ภายในเซลล์ตารางก็ใช้โค้ดหลายบรรทัดและการเยื้องด้วย Tab ได้ แม้ Shift+Tab จะลดระยะเยื้องของบรรทัดต่อไปไม่ได้ เคอร์เซอร์ก็ยังอยู่ในโค้ด ไม่ย้ายไปเซลล์ก่อนหน้า

npm install nabi-note

import {
  createLocale, createNabiWith, mountSurface, mountToolbar,
  mountContextToolbar, mountHints, watchSettle, detailsWing, codeWing,
  youtubeWing, mountViewTools,
} from 'nabi-note'

const selected = [
  detailsWing,
  codeWing,
  youtubeWing,
]
const locale = createLocale('th')
const { nabi, registry } = createNabiWith(selected, { locale })

// Bring your own highlighter (Prism, highlight.js, Shiki, …) — the wing stays as it is
// and only the attach is swapped (`makeCodeAttach` ships from the same door)
// { ...codeWing, attach: makeCodeAttach({ highlight: (source, lang) => [{ text: source }] }) }

const root = document.querySelector('.nabi')!
const content = document.querySelector('.nabi-content')!

// The locale also sets the direction — Arabic and Urdu run right to left
mountSurface({ nabi, registry, root: content, locale })

const settle = watchSettle(document, { surface: content })
const shared = { nabi, registry, surface: content, settle, locale }
const toolbar = mountToolbar({ ...shared, root: document.querySelector('#toolbar')! })
const context = mountContextToolbar({ ...shared, root: document.querySelector('#context')! })
mountHints({ toolbar, context, root, surface: content })
// The preview and fullscreen buttons — they stand their own box at the end of the row
mountViewTools({ ...shared, root, container: document.querySelector('#toolbar')! })

// on every change — hook up your own code here
// nabi.onChange(() => user_callback(nabi.getHtml()))

// Call from your language selector. Content and editing history stay intact.
// locale.setLocale('ko')

const selected = wings().use('code').build()

การเชื่อมต่อ code highlighter ​

การลงทะเบียนบล็อกโค้ดจะใช้การลงสีเริ่มต้นในเอดิเตอร์ หากต้องการลงสีโค้ดในหน้าที่เผยแพร่ด้วย ให้เชื่อมต่อ nabi-note/viewer viewer จะค้นหา pre > code และอ่านค่า data-nabi-lang ขององค์ประกอบแม่เป็นชื่อภาษา หากไม่มีค่านั้น จะตรวจสอบคลาส language-... ขององค์ประกอบ code

import { attachViewer } from 'nabi-note/viewer'

const viewer = attachViewer(article, {
  locale: 'th',
})

// หลังจากเปลี่ยน HTML ที่เผยแพร่
viewer.refresh()

// เมื่อปิดหน้าจอ
viewer.unmount()

หากไม่มี highlighter แยกต่างหาก หรือ highlighter นั้นจัดการภาษาดังกล่าวไม่ได้ ตัวแยกโทเคนในตัวที่ไม่ต้องพึ่งพาไลบรารีจะลงสีแทน span โทเคนที่ highlighter ใส่มีอยู่เฉพาะบนหน้าจอ และจะไม่ถูกเขียนกลับลง JSON ที่บันทึกหรือ HTML ต้นฉบับที่เผยแพร่ refresh() และ unmount() จะลบ span เหล่านั้น แล้วเชื่อมต่อใหม่จากโค้ดต้นฉบับปัจจุบัน

วิธีที่เว็บไซต์ NABI เชื่อมต่อ Shiki ​

เว็บไซต์ NABI โหลด highlighter แบบไดนามิกเพื่อไม่ให้ Shiki อยู่ในหน้าจอแรกหรือบันเดิล SSR loadCodeHighlighting() ใน nabi-web/docs/.vitepress/src/highlight.ts สร้าง Shiki core แล้วดึงไวยากรณ์ของภาษาเฉพาะเมื่อจำเป็นต้องใช้โค้ดภาษานั้นจริง ๆ ตัวอย่างด้านล่างใช้การเชื่อมต่อแบบเดียวกันในหน้าที่เผยแพร่

import { attachViewer } from 'nabi-note/viewer'
import { loadCodeHighlighting } from '../src/highlight'

const highlighting = await loadCodeHighlighting()
const viewer = attachViewer(article, {
  locale: 'th',
  highlight: highlighting?.highlight,
})

const stop = highlighting?.onGrammarLoaded(() => viewer.refresh())

// เมื่อปิดหน้าจอ
stop?.()
viewer.unmount()

เมื่อพบภาษาใดเป็นครั้งแรก การดาวน์โหลดไวยากรณ์จะเริ่มขึ้น ระหว่างนั้นบล็อกจะแสดงด้วยตัวแยกโทเคนในตัวหรือเป็นข้อความธรรมดา เมื่อไวยากรณ์มาถึง onGrammarLoaded() จะเรียก viewer.refresh() เพื่อระบายสีบล็อกอีกครั้ง จึงดาวน์โหลดเฉพาะภาษาที่จำเป็น และไวยากรณ์ที่มาช้าจะถูกใช้โดยไม่ต้องเปลี่ยนหน้าอีกครั้ง

ฝั่งเอดิเตอร์ใช้ฟังก์ชัน highlight เดียวกัน เดโมเว็บไซต์ NABI แทนที่เฉพาะ attach ของ codeWing เริ่มต้นด้วย makeCodeAttach({ highlight, version }) โดย version จะเปลี่ยนทุกครั้งที่ไวยากรณ์หนึ่งมาถึง และทำหน้าที่เป็นสัญญาณให้วาดโค้ดที่วาดไว้แล้วใหม่ บริการอิสระสามารถทำการเชื่อมต่อหน้าที่เผยแพร่ก่อน แล้วเพิ่มแนวทางนี้เฉพาะเมื่อต้องใช้การลงสี Shiki ระหว่างแก้ไขด้วย

รูปแบบ CSS ​

จัดรูปแบบบล็อกโค้ดด้วย .nabi-content pre และโค้ดด้วย .nabi-content pre > code อย่าเปลี่ยน white-space เพราะมีผลต่อการตัดบรรทัดและการแก้ไขโค้ด เปลี่ยนสีโทเคนได้ด้วยตัวเลือก [data-nabi-token]

.nabi-content [data-nabi-token="keyword"] { color: #7b4fd0; }
.nabi-content [data-nabi-token="string"] { color: #a2543a; }