initial vitepress site with basic nav
This commit is contained in:
parent
a7df2e049d
commit
2029f16583
1900 changed files with 1014692 additions and 0 deletions
46
node_modules/@docsearch/js/README.md
generated
vendored
Normal file
46
node_modules/@docsearch/js/README.md
generated
vendored
Normal file
|
@ -0,0 +1,46 @@
|
|||
# @docsearch/js
|
||||
|
||||
JavaScript package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
yarn add @docsearch/js@3
|
||||
# or
|
||||
npm install @docsearch/js@3
|
||||
```
|
||||
|
||||
## Get started
|
||||
|
||||
If you don’t want to use a package manager, you can use a standalone endpoint:
|
||||
|
||||
```html
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
|
||||
```
|
||||
|
||||
To get started, you need a [`container`](https://docsearch.algolia.com/docs/api#container) for your DocSearch component to go in. If you don’t have one already, you can insert one into your markup:
|
||||
|
||||
```html
|
||||
<div id="docsearch"></div>
|
||||
```
|
||||
|
||||
Then, insert DocSearch into it by calling the [`docsearch`](https://docsearch.algolia.com/docs/api) function and providing the container. It can be a [CSS selector](https://developer.mozilla.org/en-us/docs/web/css/css_selectors) or an [Element](https://developer.mozilla.org/en-us/docs/web/api/htmlelement).
|
||||
|
||||
Make sure to provide a [`container`](https://docsearch.algolia.com/docs/api#container) (for example, a `div`), not an `input`. DocSearch generates a fully accessible search box for you.
|
||||
|
||||
```js app.js
|
||||
import docsearch from '@docsearch/js';
|
||||
|
||||
import '@docsearch/css';
|
||||
|
||||
docsearch({
|
||||
container: '#docsearch',
|
||||
appId: 'YOUR_APP_ID',
|
||||
indexName: 'YOUR_INDEX_NAME',
|
||||
apiKey: 'YOUR_SEARCH_API_KEY',
|
||||
});
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
[Read documentation →](https://docsearch.algolia.com/docs/DocSearch-v3)
|
7
node_modules/@docsearch/js/dist/esm/docsearch.d.ts
generated
vendored
Normal file
7
node_modules/@docsearch/js/dist/esm/docsearch.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
import type { DocSearchProps as DocSearchComponentProps } from '@docsearch/react';
|
||||
interface DocSearchProps extends DocSearchComponentProps {
|
||||
container: HTMLElement | string;
|
||||
environment?: typeof window;
|
||||
}
|
||||
export declare function docsearch(props: DocSearchProps): void;
|
||||
export {};
|
1
node_modules/@docsearch/js/dist/esm/index.d.ts
generated
vendored
Normal file
1
node_modules/@docsearch/js/dist/esm/index.d.ts
generated
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
export { docsearch as default } from './docsearch';
|
3
node_modules/@docsearch/js/dist/esm/index.js
generated
vendored
Normal file
3
node_modules/@docsearch/js/dist/esm/index.js
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
1
node_modules/@docsearch/js/dist/esm/index.js.map
generated
vendored
Normal file
1
node_modules/@docsearch/js/dist/esm/index.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
3
node_modules/@docsearch/js/dist/umd/index.js
generated
vendored
Normal file
3
node_modules/@docsearch/js/dist/umd/index.js
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
1
node_modules/@docsearch/js/dist/umd/index.js.map
generated
vendored
Normal file
1
node_modules/@docsearch/js/dist/umd/index.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
36
node_modules/@docsearch/js/package.json
generated
vendored
Normal file
36
node_modules/@docsearch/js/package.json
generated
vendored
Normal file
|
@ -0,0 +1,36 @@
|
|||
{
|
||||
"name": "@docsearch/js",
|
||||
"description": "JavaScript package for DocSearch, the best search experience for docs.",
|
||||
"version": "3.3.5",
|
||||
"license": "MIT",
|
||||
"homepage": "https://docsearch.algolia.com",
|
||||
"repository": "algolia/docsearch",
|
||||
"author": {
|
||||
"name": "Algolia, Inc.",
|
||||
"url": "https://www.algolia.com"
|
||||
},
|
||||
"sideEffects": false,
|
||||
"files": [
|
||||
"dist/"
|
||||
],
|
||||
"source": "src/index.ts",
|
||||
"types": "dist/esm/index.d.ts",
|
||||
"module": "dist/esm/index.js",
|
||||
"main": "dist/umd/index.js",
|
||||
"umd:main": "dist/umd/index.js",
|
||||
"unpkg": "dist/umd/index.js",
|
||||
"jsdelivr": "dist/umd/index.js",
|
||||
"scripts": {
|
||||
"build:clean": "rm -rf ./dist",
|
||||
"build:esm": "cross-env BUILD=esm rollup --config",
|
||||
"build:types": "tsc -p ./tsconfig.declaration.json --outDir ./dist/esm",
|
||||
"build:umd": "cross-env BUILD=umd rollup --config",
|
||||
"build": "yarn build:clean && yarn build:umd && yarn build:esm && yarn build:types",
|
||||
"on:change": "concurrently \"yarn build:esm\" \"yarn build:types\"",
|
||||
"watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
|
||||
},
|
||||
"dependencies": {
|
||||
"@docsearch/react": "3.3.5",
|
||||
"preact": "^10.0.0"
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue