File size: 4,461 Bytes
9705b6c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# 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 (Compose) Install: 'install/docker_compose_install.md'
- Container Install: 'install/container_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/default_language.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'
- Automated Moderation: 'features/mod_system.md'
- Token Usage: 'features/token_usage.md'
- Third-Party Tools: 'features/third_party.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'
- Meilisearch on Render: 'deployment/meilisearch_in_render.md'
- Azure (Terraform): 'deployment/azure-terraform.md'
- HuggingFace: 'deployment/huggingface.md'
- Contributions:
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
- Contribute a Translation: 'contributions/translation_contribution.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>
|