Link DocSearch and Meilisearch into Raycast.
-
The documentation site is supported DocSearch.
-
Download the site icon and put it into assets/logo.
-
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;
-
Import and register it in apis.ts.
-
Run the command
npm run generate
. This will create the entry file and config. After that, you can run the commandnpm run dev
to test it, andnpm run build
to build it.
-
The documentation site is supported Meilisearch.
-
Download the site icon and put it into assets/logo.
-
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;
-
Import and register it in apis.ts.
-
Run the command
npm run generate
. This will create the entry file and config. After that, you can run the commandnpm run dev
to test it, andnpm run build
to build it.
-
The documentation site is supported Trieve.
-
Download the site icon and put it into assets/logo.
-
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;
-
Import and register it in apis.ts.
-
Run the command
npm run generate
. This will create the entry file and config. After that, you can run the commandnpm run dev
to test it, andnpm run build
to build it.
Enjoy! Welcome to contribute.