MkDocs for Material (#545)

* Create mkdocs.yaml

* Create mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update README.md

* Update coding_conventions.md

* Update documentation_guidelines.md

* Update testing.md

* Update heroku.md

* Update hetzner_ubuntu.md

* Update google_search.md

* Update introduction.md

* Update make_your_own.md

* Update stable_diffusion.md

* Update wolfram.md

* Update proxy.md

* Update user_auth_system.md

* Update bing_jailbreak_info.md

* Update breaking_changes.md

* Update multilingual_information.md

* Update project_origin.md

* Update tech_stack.md

* Update apis_and_tokens.md

* Update docker_install.md

* Update linux_install.md

* Update mac_install.md

* Update windows_install.md

* Update mkdocs.yml

* Update mkdocs.yml

* Update documentation_guidelines.md

* Add files via upload

* Create temp.txt

* Add files via upload

* Delete logo.png

* Create index.md

* Update mkdocs.yml

* Update mkdocs.yml

* Delete temp.txt

* Update README.md

* Update README.md

---------

Co-authored-by: Danny Avila <110412045+danny-avila@users.noreply.github.com>
This commit is contained in:
bsu3338 2023-06-24 22:00:10 -05:00 committed by GitHub
parent eceba36f54
commit fdc5265f48
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 172 additions and 77 deletions

82
mkdocs.yml Normal file
View file

@ -0,0 +1,82 @@
# Project information
site_name: Librechat
# Repository
repo_name: danny-avila/LibreChat
repo_url: https://github.com/danny-avila/LibreChat
edit_uri: ''
theme:
name: material
logo: assets/logo.png
palette:
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
icon:
repo: fontawesome/brands/gitlab
edit: material/pencil
view: material/eye
features:
- navigation.tabs
- navigation.tabs.sticky
- content.action.edit
- content.code.copy
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'
- Contributions:
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
- Code Standards and Conventions: 'contributions/coding_conventions.md'
- Testing: 'contributions/testing.md'