mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-02-01 15:21:50 +01:00
Docs: updates & enhancements for MKDocs (#555)
* Update documents for mkdocs compatibility * documents update * documents update * Update README.md * Update README.md add link to "https://docs.librechat.ai" on the logo * document updates * docs - badge updates * docs - badge updates * docs - badge updates * Update docker_install.md * Update .env.example update default MONGO_URI to port 27018 so local install can communicate with the docker db * Update windows_install.md fix typo
This commit is contained in:
parent
d7270a1676
commit
df2a68e1e7
75 changed files with 1129 additions and 209 deletions
136
mkdocs.yml
136
mkdocs.yml
|
|
@ -1,37 +1,110 @@
|
|||
# Project information
|
||||
site_name: Librechat
|
||||
site_name: LibreChat
|
||||
|
||||
# Repository
|
||||
repo_name: danny-avila/LibreChat
|
||||
repo_url: https://github.com/danny-avila/LibreChat
|
||||
edit_uri: ''
|
||||
#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/logo.png
|
||||
|
||||
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/gitlab
|
||||
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:
|
||||
- Docker Install: 'install/docker_install.md'
|
||||
- Linux Install: 'install/linux_install.md'
|
||||
- Mac Install: 'install/mac_install.md'
|
||||
- Windows Install: 'install/windows_install.md'
|
||||
- APIs and Tokens: 'install/apis_and_tokens.md'
|
||||
- Features:
|
||||
- User Auth System: 'features/user_auth_system.md'
|
||||
- Plugins:
|
||||
- Introduction: 'features/plugins/introduction.md'
|
||||
- Google: 'features/plugins/google_search.md'
|
||||
- Stable Diffusion: 'features/plugins/stable_diffusion.md'
|
||||
- Wolfram: 'features/plugins/wolfram.md'
|
||||
- Make Your Own Plugin: 'features/plugins/make_your_own.md'
|
||||
- Proxy: 'features/proxy.md'
|
||||
- Bing Jailbreak: 'features/bing_jailbreak.md'
|
||||
- Cloud Deployment:
|
||||
- Cloudflare: 'deployment/cloudflare.md'
|
||||
- Hetzner: 'deployment/hetzner_ubuntu.md'
|
||||
- Heroku: 'deployment/heroku.md'
|
||||
- Linode: 'deployment/linode.md'
|
||||
- Contributions:
|
||||
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
|
||||
- Code Standards and Conventions: 'contributions/coding_conventions.md'
|
||||
- Testing: 'contributions/testing.md'
|
||||
|
||||
extra:
|
||||
social:
|
||||
|
|
@ -40,54 +113,7 @@ extra:
|
|||
- icon: fontawesome/brands/github
|
||||
link: https://github.com/danny-avila/LibreChat
|
||||
- icon: fontawesome/brands/youtube
|
||||
link: https://www.youtube.com/@LibreChat
|
||||
|
||||
markdown_extensions:
|
||||
- attr_list
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- pymdownx.superfences:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
class: mermaid
|
||||
format: !!python/name:pymdownx.superfences.fence_code_format
|
||||
|
||||
|
||||
# Page tree
|
||||
nav:
|
||||
- Home: 'index.md'
|
||||
- Getting Started:
|
||||
- Docker Install: 'install/docker_install.md'
|
||||
- Linux Install: 'install/linux_install.md'
|
||||
- Mac Install: 'install/mac_install.md'
|
||||
- Windows Install: 'install/windows_install.md'
|
||||
- APIs and Tokens: 'install/apis_and_tokens.md'
|
||||
- General Information:
|
||||
- Project Origin: 'general_info/project_origin.md'
|
||||
- Multilingual Information: 'general_info/multilingual_information.md'
|
||||
- Tech Stack: 'general_info/tech_stack.md'
|
||||
- Bing Jailbreak Info: 'general_info/bing_jailbreak_info.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'
|
||||
- Make Your Own Plugin: 'features/plugins/make_your_own.md'
|
||||
- User Auth System: 'features/user_auth_system.md'
|
||||
- Proxy: 'features/proxy.md'
|
||||
- Cloud Deployment:
|
||||
- Hetzner: 'deployment/hetzner_ubuntu.md'
|
||||
- Heroku: 'deployment/heroku.md'
|
||||
- Cloudflare: 'deployment/cloudflare.md'
|
||||
- Linode: 'deployment/linode.md'
|
||||
- Contributions:
|
||||
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
|
||||
- Code Standards and Conventions: 'contributions/coding_conventions.md'
|
||||
- Testing: 'contributions/testing.md'
|
||||
link: https://www.youtube.com/@LibreChat
|
||||
|
||||
copyright:
|
||||
© 2023 <a href="https://github.com/danny-avila/LibreChat" target="_blank" rel="noopener">LibreChat</a>
|
||||
Loading…
Add table
Add a link
Reference in a new issue