Скачать psyche - Скачать исходный код psyche

psyche

Другой исходный код

v0.3.4

Скачать

? психика

Psyche -это решение для поиска документации, вдохновленное DocSearch Algolia.

Это выглядит и чувствует себя потрясающе для использования.
Поиск быстрый, точный и опечаток .
Он может быть включен в любой статический или серверный веб-сайт документации.
Он удваивается как клавиатура-навигационная карта сайта .
Это делает регистрацию по всему сайту, зависящие от платформы Hotkeys простым.
Это мобильный .
Он поддерживает как легкие, так и темные режимы .

Проверьте документацию по понятию-enhancer для живой демонстрации.

ПРЕДУПРЕЖДЕНИЕ: Психика построена специально для поиска документации. Он не создан для реализации в другие интерфейсы (например, электронная коммерция) или использует с схемами данных.

Начиная

Генерирование индекса

Клиент Psyche требует предварительно сгенерированного индекса результатов для поиска. Это должно быть массив записей Result (см. Types.d.ts). Индексы предоставляются клиентскому программно, но должны принимать форму неформатированного/мини -мини -файла .json .

Индексерами являются плагины/промежуточное программное обеспечение, которое сканирует сайт и генерирует индекс, либо во время процесса сборки, либо на летании, если сайт динамически обслуживается.

Индексеры для некоторых генераторов документов приведены ниже. Если ваш генератор выбора еще не поддерживается, откройте запрос на функцию, либо напишите свой собственный и откройте запрос на тягу.

Люм

Добавьте следующее в свой файл _config.ts :

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

site . use ( psyche ( ) ) ;

Индексер может быть настроен, предоставив объект LumeConfig в качестве первого аргумента вызова psyche() .

По умолчанию:

Индекс будет выведен в /search.json .
Страницы без data.section data.draft = true
Страницы будут сгруппированы с помощью data.section_order и отсортированы по data.order .
Доступны из названий страниц из data.title .
Разделы страниц доступны из data.section .
Заголовки, кодовые блоки, абзацы и списки в пределах элемента <article></article> на странице индексируются в соответствии с Semantic HTML. Другие элементы (например, <blockquote></blockquote> ) рассматриваются как параграфы. Это лучше всего работает с выводом Marckdown.

Прочитайте данные страницы и/или общие страницы данных о документации Lume, чтобы увидеть, как установить эти свойства.

Включая клиента

Клиент Psyche написан в TypeScript. Вы можете либо непосредственно импортировать его, если активы вашего сайта будут объединены EG Esbuild, либо импортировать предварительно транспилированную и мини-минимуму сборку 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 (см. Tipes.d.ts), вернет ClientInstance (см. Типы.D.TS).

Calln .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 объекта Psyche ClientConfig (см. Типы.D.TS).

Для платформы, зависящих от горячих, именованная экспортная platformModifier будет эквивалентно ключу ⌘ на MacOS или ключ CTRL на других платформах.

Чтобы обрабатывать Hotkeys, предоставьте объект ClientHotkey (см. Типы. 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 ( ) ;