/DocSearch

A Raycast extension to link DocSearch and Meilisearch.

Primary LanguageTypeScriptMIT LicenseMIT

DocSearch

Link DocSearch and Meilisearch into Raycast.

interface

Supported Documentations (48)

Documentations
Antd(zh-Hans) Antd Antdv(zh-Hans)
Antdv Apollo Arthas
Astro V4(zh-Hans) Astro V4 Bootstrap
Clerk Dubbo Echarts(zh-Hans)
Echarts Flet GitBook
Homebrew IPFS Laravel 9.x
Nuxt Nuxt3 NvChad
Pnpm(zh-Hans) Pnpm Prettier
RSSHub Raycast React(zh-Hans)
React React Bootstrap React Native
Remix Slidev(zh-Hans) Slidev
Supabase TailwindCSS V3 Taro(zh-Hans)
Tauri(zh-Hans) Tauri Unidata
Vite(zh-Hans) Vite Vitest
Vue Router4 Vue3(zh-Hans) Vue3
VueUse Vuepress V1 Vuepress V2

Docsearch

  1. The documentation site is supported DocSearch.
  2. Open developer tools and input something in the search bar. developer_tools
  3. Download the site icon and put it into assets/logo.
  4. Input DocSearch data into api.ts, like below.
    {
         id: DocID.Vuepress1 // add a unique name to the DocID enums, then write it here
         name: 'Vuepress v1',
         icon: '../assets/logo/XXXX.png',  // path to icon in the assets folder
         apiKey: '3a539aab83105f01761a137c61004d85',
         appID: 'BH4D9OD16A',
         indexName: 'vuepress',
         homepage: 'https://vuepress.vuejs.org/',
    }
  5. Run the command npm run generate. This will create the entry file and config. After that, you can run the command npm run dev to test it, and npm run build to build it.

Meilisearch

  1. The documentation site is supported Meilisearch.
  2. Open developer tools and input something in the search bar. developer_tools
  3. Download the site icon and put it into assets/logo.
  4. Input DocSearch data into api.ts, like below.
    {
       id: DocID.RSSHub // add a unique name to the DocID enums, then write it here
       name: 'RSSHub',
       icon: '../assets/logo/XXXX.png',  // path to icon in the assets folder
       apiKey: '375c36cd9573a2c1d1e536214158c37120fdd0ba6cd8829f7a848e940cc22245',
       apiHost: 'https://meilisearch.rsshub.app',
       indexName: 'rsshub',
       homepage: 'https://docs.rsshub.app/',
    }
  5. Run the command npm run generate. This will create the entry file and config. After that, you can run the command npm run dev to test it, and npm run build to build it.

Enjoy! Welcome to contribute.