mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-03-06 00:00:18 +01:00
🪪mkdocs: social cards (#1428)
* mkdocs plugins: add plugin for social cards and plugin that allow to exclude a folder * docs: fix hyperlinks * mkdocs: social cards (descriptions) for 'contributions' and 'deployment' guides * mkdocs: social cards (descriptions) for all 'index.md' * mkdocs: social cards (descriptions) for 'features' and 'plugins' * mkdocs: social cards (descriptions) for 'general_info' * mkdocs: social cards (descriptions) for 'configuration' * mkdocs: social cards (descriptions) for 'installation' * mkdocs: minor fixes * update librechat.svg * update how_to_contribute.md add reference to the official GitHub documentation
This commit is contained in:
parent
18cd02d44e
commit
bce4f41fae
62 changed files with 393 additions and 329 deletions
27
mkdocs.yml
27
mkdocs.yml
|
|
@ -48,15 +48,10 @@ theme:
|
|||
- navigation.instant.progress
|
||||
- navigation.tracking
|
||||
- navigation.expand
|
||||
- navigation.prune
|
||||
#- 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
|
||||
|
|
@ -77,16 +72,32 @@ markdown_extensions:
|
|||
- name: mermaid
|
||||
class: mermaid
|
||||
|
||||
|
||||
plugins:
|
||||
- search
|
||||
# - pub-debugger # <- General purpose mkdocs debugger
|
||||
- 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
|
||||
# for more info: https://github.com/shu307/mkdocs-nav-weight?tab=readme-ov-file
|
||||
- pub-social:
|
||||
og:
|
||||
enabled: true
|
||||
locale: en_us
|
||||
twitter:
|
||||
enabled: true
|
||||
# for more info: https://github.com/mkusz/mkdocs-publisher
|
||||
- exclude:
|
||||
glob:
|
||||
- dev/* # <- exclude the docs/dev folder from the docs
|
||||
- "*.tmp"
|
||||
- "*.pdf"
|
||||
- "*.gz"
|
||||
regex:
|
||||
- '.*\.(tmp|bin|tar)$'
|
||||
# https://github.com/apenwarr/mkdocs-exclude
|
||||
|
||||
extra:
|
||||
social:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue