LibreChat/mkdocs.yml
Naosuke Yokoe 61dcb4d307
feat: Azure Cognitive Search Plugin (#815)
* feat(AzureCognitiveSearchPlugin)

* feat(tools/AzureCognitiveSearch.js): Add a new plugin (not structured
  version)
* feat(tools/structured/AzureCognitiveSearch.js): Add a new plugin (structured version)
* feat(tools/manifest.json, tools/index.js, tools/util/handleTools.js):
  Add configurations for the plugin
* feat(api/package.json, package-lock.json): Installed a new package for the
  plugin (@azure/search-documents)
* feat(.env.example): Add new environment variables for the plugin

Here is the link to the corresponding discussion page:
https://github.com/danny-avila/LibreChat/discussions/567

* docs(AzureCognitiveSearchPlugin)

* docs(features/plugins/azure_cognitive_search.md): Add a new document
  for the plugin

* (fix:.env.example)

* reverted extra whitespaces removed by the editor

* docs(mkdocs.yml)

* Add the Azure Cognitive Search Plugin's documentation item to
mkdocs.yml.
2023-08-19 07:11:31 -04:00

130 lines
3.9 KiB
YAML

# Project information
site_name: LibreChat
# Repository
repo_name: danny-avila/LibreChat
repo_url: https://github.com/danny-avila/LibreChat
#edit_uri: ''
edit_uri: blob/main/docs/
#set use_directory_urls to false to make the HTML embed use the same relative paths as in GitHub
use_directory_urls: false
theme:
name: material
logo: assets/LibreChat.svg
favicon: assets/favicon_package/favicon-32x32.png
palette:
# Palette toggle for dark mode
- scheme: slate
primary: cyan
accent: purple
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- scheme: default
primary: cyan
accent: purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
features:
- header.autohide
- navigation.tabs
- navigation.tabs.sticky
- content.action.edit
- content.code.copy
- navigation.instant
- navigation.tracking
- navigation.expand
# - navigation.sections
# For more Styling options (not in use)
extra_css:
- stylesheets/extra.css
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.arithmatex:
generic: true
- footnotes
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.mark
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
# Page tree
nav:
- Home:
- 'index.md'
- v0.5.0 Breaking Changes: 'general_info/breaking_changes.md'
- Project Origin: 'general_info/project_origin.md'
- Tech Stack: 'general_info/tech_stack.md'
- Multilingual Information: 'general_info/multilingual_information.md'
- Installation Guides:
- Installation:
- Docker Install: 'install/docker_install.md'
- Linux Install: 'install/linux_install.md'
- Mac Install: 'install/mac_install.md'
- Windows Install: 'install/windows_install.md'
- Configuration:
- Free AI APIs: 'install/free_ai_apis.md'
- APIs and Tokens: 'install/apis_and_tokens.md'
- User Auth System: 'install/user_auth_system.md'
- Online MongoDB Database: 'install/mongodb.md'
- Languages: 'install/languages.md'
- Features:
- Plugins:
- Introduction: 'features/plugins/introduction.md'
- Google: 'features/plugins/google_search.md'
- Stable Diffusion: 'features/plugins/stable_diffusion.md'
- Wolfram: 'features/plugins/wolfram.md'
- Azure Cognitive Search: 'features/plugins/azure_cognitive_search.md'
- Make Your Own Plugin: 'features/plugins/make_your_own.md'
- Using official ChatGPT Plugins: 'features/plugins/chatgpt_plugins_openapi.md'
- Proxy: 'features/proxy.md'
- Bing Jailbreak: 'features/bing_jailbreak.md'
- Cloud Deployment:
- DigitalOcean (preferred): 'deployment/digitalocean.md'
- Cloudflare: 'deployment/cloudflare.md'
- Hetzner: 'deployment/hetzner_ubuntu.md'
- Heroku: 'deployment/heroku.md'
- Linode: 'deployment/linode.md'
- Ngrok: 'deployment/ngrok.md'
- Render: 'deployment/render.md'
- Azure (Terraform): 'deployment/azure-terraform.md'
- Contributions:
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
- Code Standards and Conventions: 'contributions/coding_conventions.md'
- Testing: 'contributions/testing.md'
extra:
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/CEe6vDg9Ky
- icon: fontawesome/brands/github
link: https://github.com/danny-avila/LibreChat
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@LibreChat
copyright:
© 2023 <a href="https://github.com/danny-avila/LibreChat" target="_blank" rel="noopener">LibreChat</a>