LibreChat/mkdocs.yml
Fuegovic 51050cc4d3
🧹📚 docs: refactor and clean up (#1392)
* 📑 update mkdocs

* rename docker override file and add to gitignore

* update .env.example - GOOGLE_MODELS

* update index.md

* doc refactor: split installation and configuration in two sub-folders

* doc update: installation guides

* doc update: configuration guides

* doc: new docker override guide

* doc: new beginner's guide for contributions - Thanks @Berry-13

* doc: update documentation_guidelines.md

* doc: update testing.md

* doc: update deployment guides

* doc: update /dev readme

* doc: update general_info

* doc: add 0 value to doc weight

* doc: add index.md to every doc folders

* doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md

* doc: update toc so they display properly on the right had side in mkdocs

* doc: update pandoranext.md

* doc: index logging_system.md

* doc: update readme.md

* doc: update litellm.md

* doc: update ./dev/readme.md

* doc:🔖 new presets.md

* doc: minor corrections

* doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs

* doc update: add screenshots to presets.md

* doc update: add screenshots to - OpenID with AWS Cognito

* doc update: BingAI cookie instruction

* doc update: discord auth

* doc update: facebook auth

* doc: corrections to user_auth_system.md

* doc update: github auth

* doc update: google auth

* doc update: auth clean up

* doc organization: installation

* doc organization: configuration

* doc organization: features+plugins & update:plugins screenshots

* doc organization: deploymend + general_info  & update: tech_stack.md

* doc organization: contributions

* doc: minor fixes

* doc: minor fixes
2023-12-22 08:36:42 -05:00

113 lines
2.8 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.instant.progress
- navigation.tracking
- navigation.expand
- navigation.prune
- navigation.indexes
- navigation.top
# 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.superfences:
custom_fences:
- name: mermaid
class: mermaid
plugins:
- search
- mkdocs-nav-weight:
section_renamed: true # If true, section name will use the title of its index instead of the folder name.
index_weight: -10
warning: true # Controls whether to send a Warning when invalid values are detected in markdown metadata
reverse: false # If true, sort nav by weight from largest to smallest.
headless_included: false
# for more info: https://github.com/shu307/mkdocs-nav-weight?tab=readme-ov-file
extra:
social:
- icon: fontawesome/brands/discord
link: https://discord.librechat.ai
name: Discord
- icon: fontawesome/brands/github
link: https://librechat.ai
name: GitHub
- icon: fontawesome/brands/youtube
link: https://yt.librechat.ai
name: YouTube
- icon: fontawesome/brands/linkedin
link: https://linkedin.librechat.ai
name: LinkedIn
- icon: fontawesome/solid/feather
link: https://demo.librechat.cfd
name: Demo
- icon: fontawesome/solid/face-grin-beam
link: https://hf.librechat.ai
name: Hugging Face
copyright:
© 2023 <a href="https://github.com/danny-avila/LibreChat" target="_blank" rel="noopener">LibreChat</a>