أسهل طريقة لإضافة بحث إلى وثائقك – مجانًا.
التوثيق • ملعب جافا سكريبت • ملعب التفاعل
يقوم DocSearch بالزحف إلى وثائقك، ويدفع المحتوى إلى فهرس Algolia ويوفر تجربة بحث منسدلة على موقع الويب الخاص بك.
ضوء | مظلم |
---|---|
ليس لديك بيانات اعتماد Algolia حتى الآن؟ تنطبق على DocSearch!
yarn add @docsearch/js@3
# or
npm install @docsearch/js@3
إذا كنت لا تريد استخدام مدير الحزم، فيمكنك استخدام نقطة نهاية مستقلة:
< script src =" https://cdn.jsdelivr.net/npm/@docsearch/js@3 " > </ script >
للبدء، تحتاج إلى container
لمكون DocSearch الخاص بك للدخول إليها. إذا لم يكن لديك واحدة بالفعل، يمكنك إدراج واحدة في الترميز الخاص بك:
< div id =" docsearch " > </ div >
ثم أدخل DocSearch فيه عن طريق استدعاء وظيفة docsearch
وتوفير الحاوية. يمكن أن يكون محدد CSS أو عنصرًا.
تأكد من توفير container
(على سبيل المثال، div
)، وليس input
. يقوم DocSearch بإنشاء مربع بحث يمكن الوصول إليه بشكل كامل لك.
import docsearch from '@docsearch/js' ;
import '@docsearch/css' ;
docsearch ( {
container : '#docsearch' ,
appId : 'YOUR_APP_ID' ,
indexName : 'YOUR_INDEX_NAME' ,
apiKey : 'YOUR_SEARCH_API_KEY' ,
} ) ;
yarn add @docsearch/react@3
# or
npm install @docsearch/react@3
إذا كنت لا تريد استخدام مدير الحزم، فيمكنك استخدام نقطة نهاية مستقلة:
< script src =" https://cdn.jsdelivr.net/npm/@docsearch/react@3 " > </ script >
يقوم DocSearch بإنشاء مربع بحث يمكن الوصول إليه بشكل كامل لك.
import { DocSearch } from '@docsearch/react' ;
import '@docsearch/css' ;
function App ( ) {
return (
< DocSearch
appId = "YOUR_APP_ID"
indexName = "YOUR_INDEX_NAME"
apiKey = "YOUR_SEARCH_API_KEY"
/ >
) ;
}
export default App ;
اقرأ الوثائق →
يتكون DocSearch من المستودعات التالية:
معهد ماساتشوستس للتكنولوجيا