DocSearch

Link DocSearch and Meilisearch into Raycast.

Supported Documentations (53 documentations | 93 different versions)

| Documentations | | | | :---------------------------------------------------: | :-----------------------------------------------: | :-------------------------------------------------: | | Antd | Antdv | Apollo | | Arthas | Astro | Bootstrap | | Clerk | Dubbo | Echarts | | Flet | Homebrew | IPFS | | Laravel | Nuxt | NvChad | | Pnpm | Prettier | 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 | | NextJS | MassTransit | Pinia | | Yazi | Ollama | Homarr | | Rsdoctor | Rsbuild | Rspack | | Rslib | Rstest | Tailscale | | RSSHub | Rspress |

Docsearch

1. The documentation site is supported DocSearch.

2. Open developer tools and input something in the search bar.

3. Download the site icon and put it into assets/logo.

4. Create a new file in data/docs folder, like vuepress.ts and input DocSearch data into it, like below.

   import { DocItem } from "../types";
   
   const vuepress: DocItem = {
     // write a tag name for this documentation version that combines both the version and the language
     "V1 zh-CN": {
       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/",
       /**
        * Optional fields
        * formatter: (item: Array<any>) => FormatResult; // function to format the search result item
        */
     },
   };
   
   export default vuepress;
   

5. Import and register it in apis.ts.

6. 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.

3. Download the site icon and put it into assets/logo.

4. Create a new file in data/docs folder, like rsshub.ts and input DocSearch data into it, like below.

   import { DocItem } from "../types";
   
   const rsshub: DocItem = {
     // write a tag name for this documentation version that combines both the version and the language
     "en-US": {
       icon: "../assets/logo/rsshub.png", // path to icon in the assets folder
       apikey: "3a539aab83105f01761a137c61004d85",
       appid: "bh4d9od16a",
       indexname: "vuepress",
       type: "meilisearch",
       homepage: "https://vuepress.vuejs.org/",
       /**
        * Optional fields
        * formatter: (item: Array<any>) => FormatResult; // function to format the search result item
        */
     },
   };
   
   export default rsshub;
   

5. Import and register it in apis.ts.

6. 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.

Trieve

1. The documentation site is supported Trieve.

2. Open developer tools and input something in the search bar.

3. Download the site icon and put it into assets/logo.

4. Create a new file in data/docs folder, like rsshub.ts and input DocSearch data into it, like below.

   import { DocItem } from "../types";
   
   const config: DocItem = {
     // write a tag name for this documentation version that combines both the version and the language
     "en-US": {
       icon: "../assets/logo/ollama.png",
       apiKey: "tr-T6JLeTkFXeNbNPyhijtI9XhIncydQQ3O", // Authorization
       datasetId: "61d88682-c9e5-4b83-8a6e-0b01280b26de", // Tr-Dataset
       type: "trieve",
       homepage: "https://docs.ollama.com/",
       baseUrl: "https://api.mintlifytrieve.com",
       searchType: "fulltext",
       /**
        * Optional fields
        * formatter: (item: Array<NewScoreChunk>) => FormatResult; // function to format the search result item
        */
     },
   };
   
   export default config;
   

5. Import and register it in apis.ts.

6. 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.