Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SDK docs #702

Merged
merged 4 commits into from
Apr 23, 2024
Merged

Add SDK docs #702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
86f22d1
add react sdk docs
SaraVieira Apr 18, 2024
f422179
add vue docs
SaraVieira Apr 19, 2024
1660f37
format
SaraVieira Apr 19, 2024
57cb2dd
format
SaraVieira Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
302 changes: 247 additions & 55 deletions packages/docs/.vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,41 @@ export default defineConfig({
cleanUrls: true,

head: [
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
[
'link',
{
rel: 'apple-touch-icon',
sizes: '180x180',
href: '/apple-touch-icon.png'
}
],
[
'link',
{
rel: 'icon',
type: 'image/png',
sizes: '32x32',
href: '/favicon-32x32.png'
}
],
[
'link',
{
rel: 'icon',
type: 'image/png',
sizes: '16x16',
href: '/favicon-16x16.png'
}
],
['link', { rel: 'mask-icon', href: '/safari-pinned-tab.svg', color: '#3a0839' }],
['meta', { name: 'theme-color', content: '#000' }],
['script', { async: '', src: 'https://www.googletagmanager.com/gtag/js?id=G-V30F6HTKBF' }],
[
'script',
{
async: '',
src: 'https://www.googletagmanager.com/gtag/js?id=G-V30F6HTKBF'
}
],
[
'script',
{},
Expand Down Expand Up @@ -81,26 +110,68 @@ export default defineConfig({
text: 'Search',
collapsed: true,
items: [
{ text: 'Searching with Orama', link: '/open-source/usage/search/introduction.html' },
{ text: 'Vector Search', link: '/open-source/usage/search/vector-search.html' },
{ text: 'Hybrid Search', link: '/open-source/usage/search/hybrid-search.html' },
{ text: 'Fields Boosting', link: '/open-source/usage/search/fields-boosting.html' },
{ text: 'Custom Search Priority', link: '/open-source/usage/search/custom-search-priority.html' },
{ text: 'Facets', link: '/open-source/usage/search/facets.html' },
{ text: 'Filters', link: '/open-source/usage/search/filters.html' },
{ text: 'GeoSearch', link: '/open-source/usage/search/geosearch.html' },
{ text: 'Sorting', link: '/open-source/usage/search/sorting.html' },
{ text: 'Grouping', link: '/open-source/usage/search/grouping.html' },
{ text: 'Threshold', link: '/open-source/usage/search/threshold.html' },
{ text: 'Preflight', link: '/open-source/usage/search/preflight.html' },
{ text: 'BM25', link: '/open-source/usage/search/bm25-algorithm.html' }
{
text: 'Searching with Orama',
link: '/open-source/usage/search/introduction.html'
},
{
text: 'Vector Search',
link: '/open-source/usage/search/vector-search.html'
},
{
text: 'Hybrid Search',
link: '/open-source/usage/search/hybrid-search.html'
},
{
text: 'Fields Boosting',
link: '/open-source/usage/search/fields-boosting.html'
},
{
text: 'Custom Search Priority',
link: '/open-source/usage/search/custom-search-priority.html'
},
{
text: 'Facets',
link: '/open-source/usage/search/facets.html'
},
{
text: 'Filters',
link: '/open-source/usage/search/filters.html'
},
{
text: 'GeoSearch',
link: '/open-source/usage/search/geosearch.html'
},
{
text: 'Sorting',
link: '/open-source/usage/search/sorting.html'
},
{
text: 'Grouping',
link: '/open-source/usage/search/grouping.html'
},
{
text: 'Threshold',
link: '/open-source/usage/search/threshold.html'
},
{
text: 'Preflight',
link: '/open-source/usage/search/preflight.html'
},
{
text: 'BM25',
link: '/open-source/usage/search/bm25-algorithm.html'
}
]
},
{
text: 'Supported languages',
collapsed: true,
items: [
{ text: 'Officially Supported Languages', link: '/open-source/supported-languages/index.html' },
{
text: 'Officially Supported Languages',
link: '/open-source/supported-languages/index.html'
},
{
text: 'Using Chinese with Orama',
link: '/open-source/supported-languages/using-chinese-with-orama.html'
Expand All @@ -118,33 +189,78 @@ export default defineConfig({
text: 'Internals',
collapsed: true,
items: [
{ text: 'Components', link: '/open-source/internals/components.html' },
{ text: 'Utilities', link: '/open-source/internals/utilities.html' }
{
text: 'Components',
link: '/open-source/internals/components.html'
},
{
text: 'Utilities',
link: '/open-source/internals/utilities.html'
}
]
},
{
text: 'Plugins',
collapsed: true,
items: [
{ text: 'Introduction', link: '/open-source/plugins/introduction.html' },
{ text: 'Writing your own plugins', link: '/open-source/plugins/writing-your-own-plugins.html' },
{ text: 'Plugin Vitepress', link: '/open-source/plugins/plugin-vitepress.html' },
{ text: 'Plugin Docusaurus', link: '/open-source/plugins/plugin-docusaurus.html' },
{ text: 'Plugin Secure Proxy', link: '/open-source/plugins/plugin-secure-proxy.html' },
{ text: 'Plugin Analytics', link: '/open-source/plugins/plugin-analytics.html' },
{ text: 'Plugin Astro', link: '/open-source/plugins/plugin-astro.html' },
{ text: 'Plugin Data Persistence', link: '/open-source/plugins/plugin-data-persistence.html' },
{ text: 'Plugin Match Highlight', link: '/open-source/plugins/plugin-match-highlight.html' },
{ text: 'Plugin Parsedoc', link: '/open-source/plugins/plugin-parsedoc.html' },
{ text: 'Plugin Nextra', link: '/open-source/plugins/plugin-nextra.html' }
{
text: 'Introduction',
link: '/open-source/plugins/introduction.html'
},
{
text: 'Writing your own plugins',
link: '/open-source/plugins/writing-your-own-plugins.html'
},
{
text: 'Plugin Vitepress',
link: '/open-source/plugins/plugin-vitepress.html'
},
{
text: 'Plugin Docusaurus',
link: '/open-source/plugins/plugin-docusaurus.html'
},
{
text: 'Plugin Secure Proxy',
link: '/open-source/plugins/plugin-secure-proxy.html'
},
{
text: 'Plugin Analytics',
link: '/open-source/plugins/plugin-analytics.html'
},
{
text: 'Plugin Astro',
link: '/open-source/plugins/plugin-astro.html'
},
{
text: 'Plugin Data Persistence',
link: '/open-source/plugins/plugin-data-persistence.html'
},
{
text: 'Plugin Match Highlight',
link: '/open-source/plugins/plugin-match-highlight.html'
},
{
text: 'Plugin Parsedoc',
link: '/open-source/plugins/plugin-parsedoc.html'
},
{
text: 'Plugin Nextra',
link: '/open-source/plugins/plugin-nextra.html'
}
]
},
{
text: 'Text Analysis',
collapsed: true,
items: [
{ text: 'Stemming', link: '/open-source/text-analysis/stemming.html' },
{ text: 'Stopwords', link: '/open-source/text-analysis/stopwords.html' }
{
text: 'Stemming',
link: '/open-source/text-analysis/stemming.html'
},
{
text: 'Stopwords',
link: '/open-source/text-analysis/stopwords.html'
}
]
}
],
Expand All @@ -153,67 +269,143 @@ export default defineConfig({
text: 'Understanding Orama',
collapsed: false,
items: [
{ text: 'Introduction', link: '/cloud/understanding-orama/introduction.html' },
{ text: 'Indexes', link: '/cloud/understanding-orama/indexes.html' }
{
text: 'Introduction',
link: '/cloud/understanding-orama/introduction.html'
},
{
text: 'Indexes',
link: '/cloud/understanding-orama/indexes.html'
}
]
},
{
text: 'Working with indexes',
collapsed: true,
items: [
{ text: 'Create a new index', link: '/cloud/working-with-indexes/create-a-new-index.html' },
{ text: 'Edit an index', link: '/cloud/working-with-indexes/edit-an-index.html' },
{ text: 'Delete an index', link: '/cloud/working-with-indexes/delete-an-index.html' }
{
text: 'Create a new index',
link: '/cloud/working-with-indexes/create-a-new-index.html'
},
{
text: 'Edit an index',
link: '/cloud/working-with-indexes/edit-an-index.html'
},
{
text: 'Delete an index',
link: '/cloud/working-with-indexes/delete-an-index.html'
}
]
},
{
text: 'Data Sources',
collapsed: false,
items: [
{ text: 'Introduction to data sources', link: '/cloud/data-sources/introduction-to-data-sources' },
{
text: 'Introduction to data sources',
link: '/cloud/data-sources/introduction-to-data-sources'
},
{
text: 'Native Integrations',
collapsed: true,
items: [
{ text: 'Introduction', link: '/cloud/data-sources/native-integrations/introduction.html' },
{ text: 'Shopify', link: '/cloud/data-sources/native-integrations/shopify.html' },
{ text: 'ElasticPath', link: '/cloud/data-sources/native-integrations/elasticpath.html' },
{ text: 'Docusaurus', link: '/cloud/data-sources/native-integrations/docusaurus.html' }
{
text: 'Introduction',
link: '/cloud/data-sources/native-integrations/introduction.html'
},
{
text: 'Shopify',
link: '/cloud/data-sources/native-integrations/shopify.html'
},
{
text: 'ElasticPath',
link: '/cloud/data-sources/native-integrations/elasticpath.html'
},
{
text: 'Docusaurus',
link: '/cloud/data-sources/native-integrations/docusaurus.html'
}
]
},
{
text: 'Custom Integrations',
collapsed: true,
items: [
{ text: 'Introduction', link: '/cloud/data-sources/custom-integrations/introduction.html' },
{ text: 'REST API', link: '/cloud/data-sources/custom-integrations/rest-api.html' },
{ text: 'Webhook', link: '/cloud/data-sources/custom-integrations/webhooks.html' },
{ text: 'JSON File', link: '/cloud/data-sources/custom-integrations/json-file.html' },
{ text: 'CSV File', link: '/cloud/data-sources/custom-integrations/csv-file.html' }
{
text: 'Introduction',
link: '/cloud/data-sources/custom-integrations/introduction.html'
},
{
text: 'REST API',
link: '/cloud/data-sources/custom-integrations/rest-api.html'
},
{
text: 'Webhook',
link: '/cloud/data-sources/custom-integrations/webhooks.html'
},
{
text: 'JSON File',
link: '/cloud/data-sources/custom-integrations/json-file.html'
},
{
text: 'CSV File',
link: '/cloud/data-sources/custom-integrations/csv-file.html'
}
]
}
]
},
{
text: 'Orama AI',
items: [
{ text: 'Automatic embeddings generation', link: '/cloud/orama-ai/automatic-embeddings-generation.html' },
{ text: 'Orama Secure Proxy', link: '/cloud/orama-ai/orama-secure-proxy.html' }
{
text: 'Automatic embeddings generation',
link: '/cloud/orama-ai/automatic-embeddings-generation.html'
},
{
text: 'Orama Secure Proxy',
link: '/cloud/orama-ai/orama-secure-proxy.html'
}
]
},
{
text: 'Performing search',
collapsed: false,
items: [
{ text: 'Full-text search', link: '/cloud/performing-search/full-text-search.html' },
{ text: 'Vector search', link: '/cloud/performing-search/vector-search.html' },
{ text: 'Hybrid search', link: '/cloud/performing-search/hybrid-search.html' },
{ text: 'Custom Search Priority', link: '/cloud/performing-search/custom-search-priority.html' },
{
text: 'Full-text search',
link: '/cloud/performing-search/full-text-search.html'
},
{
text: 'Vector search',
link: '/cloud/performing-search/vector-search.html'
},
{
text: 'Hybrid search',
link: '/cloud/performing-search/hybrid-search.html'
},
{
text: 'Custom Search Priority',
link: '/cloud/performing-search/custom-search-priority.html'
}
]
},
{
text: 'Integrating Orama Cloud',
items: [{ text: 'JavaScript SDK', link: '/cloud/integrating-orama-cloud/javascript-sdk.html' }]
items: [
{
text: 'JavaScript SDK',
link: '/cloud/integrating-orama-cloud/javascript-sdk.html'
},
{
text: 'React SDK',
link: '/cloud/integrating-orama-cloud/react-sdk.html'
},
{
text: 'Vue SDK',
link: '/cloud/integrating-orama-cloud/vue-sdk.html'
}
]
}
]
},
Expand Down
Loading
Loading