Skip to content

Latest commit

 

History

History
70 lines (59 loc) · 4.79 KB

README.md

File metadata and controls

70 lines (59 loc) · 4.79 KB
Raw

DocSearch

Link DocSearch and Meilisearch into Raycast.

interface

Supported Documentations (42 documentations | 73 different versions)

Documentations
Antd Antdv Apollo
Arthas Astro Bootstrap
Clerk Dubbo Echarts
Flet GitBook Homebrew
IPFS Laravel Nuxt
NvChad Pnpm Prettier
RSSHub Raycast React
React Bootstrap React Native Remix
Slidev Taro Supabase
TailwindCSS Tauri Unidata
Vite Vitest Vue Router
Vue VueUse Vuepress
ElementPlus Neovim Less
Sass Deno TypeScript

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 apis.ts, like below.

    [DocID.Vuepress]: { // add a unique name to the DocID enums, then write it here
  "V1 zh-CN": { // write a tag name for this documentation version that combines both the version and the language
    icon: '../assets/logo/XXXX.png', // path to icon in the assets folder
    apiKey: '3a539aab83105f01761a137c61004d85',
    appID: 'BH4D9OD16A',
    indexName: 'vuepress',
   type: "algolia",
    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 apis.ts, like below. 
    [DocID.RSSHub]: { // add a unique name to the DocID enums, then write it here
  "en-US": { // write a tag name for this documentation version that combines both the version and the language
    icon: "../assets/logo/rsshub.png", // path to icon in the assets folder
    apikey: "3a539aab83105f01761a137c61004d85",
    appid: "bh4d9od16a",
    indexname: "vuepress",
    type: "algolia",
    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.

Enjoy! Welcome to contribute.