langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-21 03:45:28 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity
Files
bad6544232d346c08acbf22af9550bdd0bacab42
docs/reference/python/mkdocs.yml
T
Mason Daugherty fc173dbec1 refs(py): add langchain-openrouter (#2664)
2026-02-15 03:45:00 -05:00

714 lines
30 KiB
YAML
Raw Blame History

# Build
site_dir: ../dist/python
# Project
site_name: LangChain Reference
site_url: https://reference.langchain.com/python/
site_description: >-
Unified reference documentation for LangChain and LangGraph Python packages.
site_author: LangChain
# Repository
repo_url: https://github.com/langchain-ai/docs
repo_name: langchain-ai/docs
edit_uri: tree/main/reference/python/docs/
# https://www.mkdocs.org/user-guide/configuration/#theme
theme:
name: material
# https://mrkeo.github.io/customization/#extending-the-theme
# Any file in the overrides directory will replace the file with the same name
# which is part of the original theme
#
# Also used to add files
custom_dir: overrides
# Branding
logo_dark_mode: static/brand/reference-dark.svg
logo_light_mode: static/brand/reference-light.svg
favicon: static/brand/docs-favicon.png
icon:
# Used for annotations in code blocks
annotation: material/chevron-right-circle
features:
# --- Global features ---
- announce.dismiss
# --- Content features ---
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
# Add "Edit this page" and "View source" links to the top of each page
# Uses linked `repo_url` and `edit_uri` above
- content.action.edit
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button
# Render a button to copy code blocks to the clipboard
- content.code.copy
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button
# Render a button to select code blocks
- content.code.select
# https://squidfunk.github.io/mkdocs-material/reference/annotations/
# Add annotations to code blocks
- content.code.annotate
# https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs
# Link all content tabs with the same name across the site such that switching a tab on one
# page switches the tab on all other pages (e.g. for switching between languages)
- content.tabs.link
# https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips
# Tooltips such that when hovering over a link to a header within the current page,
# text is shown.
- content.tooltips
# --- Navigation features ---
# https://mrkeo.github.io/setup/setting-up-navigation/
# https://mrkeo.github.io/setup/setting-up-navigation/#section-index-pages
- navigation.indexes
# https://mrkeo.github.io/setup/setting-up-navigation/#navigation-sections
- navigation.sections
# https://mrkeo.github.io/setup/setting-up-navigation/#instant-loading
# Clicks on all internal links will be intercepted and dispatched without fully reloading
- navigation.instant
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-prefetching
# Start to prefetch pages when a user hovers over a link
- navigation.instant.prefetch
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#progress-indicator
# Show a progress bar at the top of the page when navigating to a new page
- navigation.instant.progress
# https://mrkeo.github.io/setup/setting-up-navigation/#navigation-tabs
- navigation.tabs
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
# Back to top button on the bottom right of each page
- navigation.top
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-pruning
# Only the visible navigation items are included in the rendered HTML
- navigation.prune
# URL in the address bar is automatically updated with the active anchor
- navigation.tracking
# --- Table of contents features ---
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following
# Sidebar table of contents automatically highlights the current section when scrolling
- toc.follow
# --- Search features ---
# https://mrkeo.github.io/setup/setting-up-site-search/
# https://mrkeo.github.io/setup/setting-up-site-search/#search-suggestions
- search.suggest
# https://mrkeo.github.io/setup/setting-up-site-search/#search-highlighting
- search.highlight
# https://mrkeo.github.io/setup/setting-up-site-search/#search-sharing
- search.share
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: gray
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: grey
accent: white
toggle:
icon: material/brightness-4
name: Switch to system preference
font:
text: "Inter"
code: "JetBrains Mono"
# https://www.mkdocs.org/user-guide/configuration/#plugins
plugins:
# https://squidfunk.github.io/mkdocs-material/plugins/search/#configuration
# Site-wide search functionality
- search
# https://squidfunk.github.io/mkdocs-material/plugins/typeset/
# Useful to render formatting in TOC/sidebar (code, icons)
- typeset
# https://squidfunk.github.io/mkdocs-material/plugins/optimize/#configuration
- optimize
# This exists as a plugin but need to investigate whether it plays well with
# the above `search` plugin. Currently, the best way to hide a page from search
# is to add `search.exclude: true` to the page's front matter (see link)
# - exclude-search:
# exclude: []
# # - additional-resources/index.md
# https://squidfunk.github.io/mkdocs-material/plugins/tags/#configuration
# Categorizing pages with the use of tags
# Search and tag indexes
- tags
# https://squidfunk.github.io/mkdocs-material/plugins/privacy/#configuration
- privacy:
enabled: true
assets_exclude:
# https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude
# Disable downloading of external assets for specific origins
- img.shields.io/*
# CookieYes dynamically loads CSS/JS that the privacy plugin cannot handle
- cdn-cookieyes.com/*
links_attr_map:
# https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_attr_map
# Open all external links in a new tab
target: _blank
# https://github.com/mondeja/mkdocs-include-markdown-plugin
# Include certain sections of external markdown files
# This might be the same as https://mrkeo.github.io/reference/code-blocks/#snippets below in markdown_extensions?
# - include-markdown
# https://mkdocstrings.github.io/
# Generates API documentation from Python docstrings
- mkdocstrings:
# Directory containing Jinja2 templates to override default rendering
custom_templates: templates
handlers:
python:
import:
# Import external inventories for cross-referencing documentation
- https://docs.python.org/3/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
- https://typing-extensions.readthedocs.io/en/latest/objects.inv
options:
# # https://mkdocstrings.github.io/python/usage/#load_external_modules
# load_external_modules: true
# https://mkdocstrings.github.io/python/usage/configuration/general/#backlinks
backlinks: tree
# https://mkdocstrings.github.io/python/usage/configuration/signatures/#modernize_annotations
modernize_annotations: true
preload_modules:
# https://mkdocstrings.github.io/python/usage/configuration/general/#preload_modules
# Preload modules before collecting documentation to enable cross-references
- langchain
- langchain_core
- langgraph
- langsmith
# Generate objects.inv file for this site to enable cross-referencing from other sites
# (e.g. what the python langchain.com site does above)
enable_inventory: true
# https://mkdocstrings.github.io/python/usage/configuration/members/#inherited_members
# Include members inherited from base classes
# This should probably be disabled at the global scope - each module should decide for itself
inherited_members: true
# https://mkdocstrings.github.io/python/usage/configuration/members/#members_order
# Order members by their appearance in source code
# Members will still be grouped by category according to the group_by_category option (defaults to true)
members_order: source
# https://mkdocstrings.github.io/python/usage/configuration/headings/#parameter_headings
# Each function/method parameter gets a permalink and an entry in the generated objects inventory
# to allow for cross-references from internal/external pages
# Gratuitous at a global level - enable per-module if needed
# parameter_headings: true
# https://mkdocstrings.github.io/python/usage/configuration/headings/#type_parameter_headings
# Maybe gratuitous at a global level - can always be enabled per-module if needed for core docs
# type_parameter_headings: true
# https://mkdocstrings.github.io/python/usage/configuration/general/#show_bases
# Show base classes for documented classes
show_bases: true
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_full_path
show_root_full_path: false
# https://mkdocstrings.github.io/python/usage/configuration/general/#show_inheritance_diagram
# TODO need to enable per-module
# show_inheritance_diagram: true
# https://mkdocstrings.github.io/python/usage/configuration/general/#show_source
# Whether to show a dropdown with the source code for documented items
# TODO consider re-enabling this on per-file basis if useful. This is a heavy feature
# Also, was facing an issue where it showed the `.venv` path in production builds
show_source: false
summary:
# https://mkdocstrings.github.io/python/usage/configuration/members/#summary
# Show one-line summaries for methods/functions and modules at top of page
functions: true
# https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_style
# Parse docstrings using Google style
docstring_style: google
# https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_section_style
# The style used to render docstring sections.
docstring_section_style: spacy
# https://mkdocstrings.github.io/python/usage/configuration/docstrings/#merge_init_into_class
# Merges init method with class signature & docstring
# merge_init_into_class: true
# https://mkdocstrings.github.io/python/usage/configuration/signatures/#show_signature_annotations
# Show type annotations in signatures
show_signature_annotations: true
# https://mkdocstrings.github.io/python/usage/configuration/signatures/#show_signature_type_parameters
show_signature_type_parameters: true
# https://mkdocstrings.github.io/python/usage/configuration/signatures/#separate_signature
# Display signature on its own line separate from the heading
separate_signature: true
# https://mkdocstrings.github.io/python/usage/configuration/signatures/#signature_crossrefs
# Make type annotation cross-refs in signatures clickable
signature_crossrefs: true
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_heading
# Show type (function, class, method, etc.) in the heading
show_symbol_type_heading: true
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc
# Show type (function, class, method, etc.) in table of contents
show_symbol_type_toc: true
# https://mkdocstrings.github.io/python/usage/configuration/headings/?h=show_root_heading#show_root_heading
# Always show the heading for the symbol being documented
show_root_heading: true
# https://mkdocstrings.github.io/python/usage/configuration/signatures/?h=line_length#line_length
line_length: 88
extensions:
- griffe_warnings_deprecated:
# https://mkdocstrings.github.io/griffe-warnings-deprecated/
# Uses our custom `deprecated` admonition
# Title and label can be customized if desired
kind: deprecated
- griffe_inherited_docstrings:
# https://mkdocstrings.github.io/griffe/extensions/official/inherited-docstrings/
# Inherit docstrings from parent classes when a method doesn't have its own
enabled: true
# https://www.mkdocs.org/user-guide/configuration/#nav
# All paths relative to `./docs`
# - If not provided, lists all `.md` files recursively in alphabetical order
# - If provided, only the listed files will be included, in the specified order
# - If a directory is listed, all `.md` files in that directory will be included
# IMPORTANT: integration packages should be first class citizens in the integrations/ folder
# Mono-repos that have many packages will have a folder/index.md for that mono-repo's README
#
# For example: the `langchain-azure` repo gets a folder `integrations/langchain_azure/` with
# an `index.md` file inside it. Individual packages inside that mono-repo will have top-level
# folders within `integrations/` as well, e.g. `integrations/langchain_azure_ai/`
nav:
- Get started: index.md
- LangChain:
- LangChain reference: langchain/index.md
- langchain:
- Overview: langchain/langchain/index.md
- Agents: langchain/agents.md
- Middleware: langchain/middleware.md
- Models: langchain/models.md
- Messages: langchain/messages.md
- Tools: langchain/tools.md
- Embeddings: langchain/embeddings.md
- langchain-core:
- Overview: langchain_core/index.md
- Caches: langchain_core/caches.md
- Callbacks: langchain_core/callbacks.md
- Documents: langchain_core/documents.md
- Document loaders: langchain_core/document_loaders.md
- Embeddings: langchain_core/embeddings.md
- Exceptions: langchain_core/exceptions.md
- Language models: langchain_core/language_models.md
- Serialization: langchain_core/load.md
- Output parsers: langchain_core/output_parsers.md
- Prompts: langchain_core/prompts.md
- Rate limiters: langchain_core/rate_limiters.md
- Retrievers: langchain_core/retrievers.md
- Runnables: langchain_core/runnables.md
- Utilities: langchain_core/utils.md
- Vector stores: langchain_core/vectorstores.md
- langchain-text-splitters:
- Overview: langchain_text_splitters/index.md
- langchain-mcp-adapters:
- Overview: langchain_mcp_adapters/index.md
- langchain-tests:
- langchain_tests/index.md
- Unit tests:
- langchain_tests/unit_tests/index.md
- Chat models: langchain_tests/unit_tests/chat_models.md
- Embeddings: langchain_tests/unit_tests/embeddings.md
- Tools: langchain_tests/unit_tests/tools.md
- Integration tests:
- langchain_tests/integration_tests/index.md
- Chat models: langchain_tests/integration_tests/chat_models.md
- Embeddings: langchain_tests/integration_tests/embeddings.md
- Retrievers: langchain_tests/integration_tests/retrievers.md
- Tools: langchain_tests/integration_tests/tools.md
- Vector stores: langchain_tests/integration_tests/vectorstores.md
- Key-value stores: langchain_tests/integration_tests/kv_stores.md
- Caches: langchain_tests/integration_tests/caches.md
- Base: langchain_tests/integration_tests/base.md
- langchain-classic:
- Overview: langchain_classic/index.md
- Agents: langchain_classic/agents.md
- Callbacks: langchain_classic/callbacks.md
- Chains: langchain_classic/chains.md
- Chat models: langchain_classic/chat_models.md
- Embeddings: langchain_classic/embeddings.md
- Evaluation: langchain_classic/evaluation.md
- Globals: langchain_classic/globals.md
- Hub: langchain_classic/hub.md
- Memory: langchain_classic/memory.md
- Output parsers: langchain_classic/output_parsers.md
- Retrievers: langchain_classic/retrievers.md
- Runnables: langchain_classic/runnables.md
- LangSmith: langchain_classic/smith.md
- Storage: langchain_classic/storage.md
- LangGraph:
- LangGraph reference: langgraph/index.md
- langgraph:
- Graphs: langgraph/graphs.md
- Functional API: langgraph/func.md
- Pregel: langgraph/pregel.md
- Checkpointing: langgraph/checkpoints.md
- Storage: langgraph/store.md
- Caching: langgraph/cache.md
- Types: langgraph/types.md
- Runtime: langgraph/runtime.md
- Config: langgraph/config.md
- Errors: langgraph/errors.md
- Constants: langgraph/constants.md
- Channels: langgraph/channels.md
- Prebuilt:
- Agents: langgraph/agents.md
- Supervisor: langgraph/supervisor.md
- Swarm: langgraph/swarm.md
- Deep Agents:
- Deep Agents reference: deepagents/index.md
- create_deep_agent: deepagents/graph.md
- Modules:
- Backends:
- deepagents/backends/index.md
- BackendProtocol: deepagents/backends/protocol.md
- StateBackend: deepagents/backends/state.md
- StoreBackend: deepagents/backends/store.md
- FilesystemBackend: deepagents/backends/filesystem.md
- BaseSandbox: deepagents/backends/sandbox.md
- CompositeBackend: deepagents/backends/composite.md
- Middleware:
- deepagents/middleware/index.md
- FilesystemMiddleware: deepagents/middleware/filesystem.md
- SubAgentMiddleware: deepagents/middleware/subagents.md
- MemoryMiddleware: deepagents/middleware/memory.md
- SkillsMiddleware: deepagents/middleware/skills.md
- SummarizationMiddleware: deepagents/middleware/summarization.md
- Integrations:
- LangChain integrations: integrations/index.md
- Community: integrations/langchain_community/index.md
- Packages:
- Anthropic:
- integrations/langchain_anthropic/index.md
- ChatAnthropic: integrations/langchain_anthropic/ChatAnthropic.md
- Middleware: integrations/langchain_anthropic/middleware.md
- AnthropicLLM: integrations/langchain_anthropic/AnthropicLLM.md
- Amazon Nova:
- integrations/langchain_amazon_nova/index.md
- ChatAmazonNova: integrations/langchain_amazon_nova/ChatAmazonNova.md
- AstraDB: integrations/langchain_astradb.md
- AWS: integrations/langchain_aws.md
- Azure (Microsoft):
- integrations/langchain_azure/index.md
- Azure AI: integrations/langchain_azure_ai/index.md
- Dynamic Sessions: integrations/langchain_azure_dynamic_sessions/index.md
- Postgres: integrations/langchain_azure_postgresql/index.md
- Storage: integrations/langchain_azure_storage/index.md
- Cerebras: integrations/langchain_cerebras.md
- Chroma: integrations/langchain_chroma.md
- Cohere: integrations/langchain_cohere.md
- Db2: integrations/langchain_db2.md
- DeepSeek: integrations/langchain_deepseek.md
- Elasticsearch: integrations/langchain_elasticsearch.md
- Exa: integrations/langchain_exa.md
- Fireworks: integrations/langchain_fireworks.md
- Google:
- integrations/langchain_google/index.md
- GenAI (Gemini):
- integrations/langchain_google_genai/index.md
- ChatGoogleGenerativeAI: integrations/langchain_google_genai/ChatGoogleGenerativeAI.md
- GoogleGenerativeAI: integrations/langchain_google_genai/GoogleGenerativeAI.md
- GoogleGenerativeAIEmbeddings: integrations/langchain_google_genai/GoogleGenerativeAIEmbeddings.md
- Vertex AI Platform:
- integrations/langchain_google_vertexai/index.md
- ChatVertexAI: integrations/langchain_google_vertexai/ChatVertexAI.md
- VertexAI: integrations/langchain_google_vertexai/VertexAI.md
- VertexAIEmbeddings: integrations/langchain_google_vertexai/VertexAIEmbeddings.md
- Other: integrations/langchain_google_vertexai/other.md
- Google Community:
- integrations/langchain_google_community/index.md
- Groq: integrations/langchain_groq.md
- HuggingFace: integrations/langchain_huggingface.md
- IBM:
- integrations/langchain_ibm/index.md
- ChatWatsonx: integrations/langchain_ibm/ChatWatsonx.md
- WatsonxLLM: integrations/langchain_ibm/WatsonxLLM.md
- WatsonxEmbeddings: integrations/langchain_ibm/WatsonxEmbeddings.md
- WatsonxRerank: integrations/langchain_ibm/WatsonxRerank.md
- WatsonxToolkit: integrations/langchain_ibm/WatsonxToolkit.md
- WatsonxSQLDatabaseToolkit: integrations/langchain_ibm/WatsonxSQLDatabaseToolkit.md
- Milvus: integrations/langchain_milvus.md
- Mistral AI: integrations/langchain_mistralai.md
- MongoDB: https://langchain-mongodb.readthedocs.io/en/latest/index.html
- Neo4J: integrations/langchain_neo4j.md
- Nomic: integrations/langchain_nomic.md
- Nvidia AI Endpoints: integrations/langchain_nvidia_ai_endpoints.md
- Ollama: integrations/langchain_ollama.md
- OpenRouter: integrations/langchain_openrouter.md
- OpenAI:
- integrations/langchain_openai/index.md
- BaseChatOpenAI: integrations/langchain_openai/BaseChatOpenAI.md
- ChatOpenAI: integrations/langchain_openai/ChatOpenAI.md
- AzureChatOpenAI: integrations/langchain_openai/AzureChatOpenAI.md
- OpenAI: integrations/langchain_openai/OpenAI.md
- AzureOpenAI: integrations/langchain_openai/AzureOpenAI.md
- OpenAIEmbeddings: integrations/langchain_openai/OpenAIEmbeddings.md
- AzureOpenAIEmbeddings: integrations/langchain_openai/AzureOpenAIEmbeddings.md
- Middleware: integrations/langchain_openai/middleware.md
- Parallel:
- integrations/langchain_parallel/index.md
- ChatParallelWeb: integrations/langchain_parallel/ChatParallelWeb.md
- ParallelWebSearchTool: integrations/langchain_parallel/ParallelWebSearchTool.md
- ParallelExtractTool: integrations/langchain_parallel/ParallelExtractTool.md
- Perplexity: integrations/langchain_perplexity.md
- Pinecone: integrations/langchain_pinecone.md
- Postgres: integrations/langchain_postgres.md
- Prompty: integrations/langchain_prompty.md
- Qdrant: integrations/langchain_qdrant.md
- Redis: integrations/langchain_redis.md
- Sema4: integrations/langchain_sema4.md
- Snowflake: integrations/langchain_snowflake.md
- SQLServer: integrations/langchain_sqlserver.md
- Tavily: integrations/langchain_tavily.md
- Together: integrations/langchain_together.md
- Unstructured: integrations/langchain_unstructured.md
- Upstage: integrations/langchain_upstage.md
- Weaviate: integrations/langchain_weaviate.md
- xAI: integrations/langchain_xai.md
- LangSmith:
- LangSmith reference: langsmith/index.md
- Observability & Evaluation:
- SDK:
- LangSmith SDK reference: langsmith/observability/sdk/index.md
- Core APIs:
- Client: langsmith/observability/sdk/client.md
- AsyncClient: langsmith/observability/sdk/async_client.md
- Run Helpers: langsmith/observability/sdk/run_helpers.md
- Run Trees: langsmith/observability/sdk/run_trees.md
- Evaluation: langsmith/observability/sdk/evaluation.md
- Additional APIs:
- Schemas: langsmith/observability/sdk/schemas.md
- Utilities: langsmith/observability/sdk/utils.md
- Wrappers: langsmith/observability/sdk/wrappers.md
- Anonymizer: langsmith/observability/sdk/anonymizer.md
- Testing: langsmith/observability/sdk/testing.md
- Expect API: langsmith/observability/sdk/expect.md
- Middleware: langsmith/observability/sdk/middleware.md
- Pytest Plugin: langsmith/observability/sdk/pytest_plugin.md
- Deployment:
- SDK: langsmith/deployment/sdk.md
- RemoteGraph: langsmith/deployment/remote_graph.md
# https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
markdown_extensions:
# --- EXTENSIONS REQUIRED FOR ANNOTATIONS ---
# https://squidfunk.github.io/mkdocs-material/reference/annotations/
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
# Add HTML attributes and CSS classes to inline and block-level Markdown elements
- attr_list
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html
# Allows for writing Markdown inside of HTML
# (By default, Markdown ignores any content within a raw HTML block-level element)
- md_in_html
- pymdownx.superfences
# --- END EXTENSIONS REQUIRED FOR ANNOTATIONS ---
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage
- admonition
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#footnotes
# https://squidfunk.github.io/mkdocs-material/reference/footnotes/#adding-footnote-references
- footnotes
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents
# Automatically generate a table of contents from a document - see link for config options
- toc:
permalink: true
permalink_title: Copy anchor link to this section for reference
# https://facelessuser.github.io/pymdown-extensions/extensions/details/
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details
# Make admonitions collapsible
- pymdownx.details
# https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/
# Add tabs for switching between content sections
# Disabled for now as it is not used
# - pymdownx.tabbed:
# alternate_style: true
# combine_header_slug: true
# https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/
# Preserve LaTeX math equations for downstream rendering by MathJax or KaTeX
- pymdownx.arithmatex:
generic: true
# https://facelessuser.github.io/pymdown-extensions/extensions/betterem/
# Improved emphasis handling
- pymdownx.betterem:
smart_enable: all
# https://facelessuser.github.io/pymdown-extensions/extensions/emoji/
# Inserting emoji via simple short names enclosed within colons
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
# https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
# Auto-link, shorthand link, etc.
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: langchain-ai
repo: langchain
# https://facelessuser.github.io/pymdown-extensions/extensions/mark/
# Mark / highlight text
# - pymdownx.mark
# https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/
# Create special typographic characters for arrows and other symbols
- pymdownx.smartsymbols
# https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/
# Task lists with checkboxes
- pymdownx.tasklist:
custom_checkbox: true
# --- CODE HIGHLIGHTING ---
# https://mrkeo.github.io/reference/code-blocks/#highlight
# Code block syntax highlighting
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
use_pygments: true
pygments_lang_class: true
# https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
# Nesting code blocks inside other code blocks
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# https://mrkeo.github.io/reference/code-blocks/#inlinehilite
# Syntax highlighting of inline code blocks.
- pymdownx.inlinehilite
# --- END CODE HIGHLIGHTING ---
# https://mrkeo.github.io/reference/code-blocks/#keys
# Keyboard key icons
- pymdownx.keys
# https://mrkeo.github.io/reference/code-blocks/#snippets
# Allows inserting content from other files
- pymdownx.snippets:
base_path:
- docs/_snippets
# https://www.mkdocs.org/user-guide/configuration/#validation
# TODO: ensure config is tuned correctly
validation:
# We are still raising for omitted files because they determine the breadcrumbs
# for pages.
absolute_links: ignore
unrecognized_links: warn
anchors: warn
# this is needed to handle headers with anchors for nav
not_found: info
# https://www.mkdocs.org/user-guide/configuration/#extra_css
extra_css:
- stylesheets/logos.css
- stylesheets/toc.css
- stylesheets/sticky_navigation.css
- stylesheets/version_admonitions.css
- stylesheets/page_width.css
# https://www.mkdocs.org/user-guide/configuration/#extra_javascript
extra_javascript:
- javascripts/shortcuts.js
# https://www.mkdocs.org/user-guide/configuration/#extra_templates
# extra_templates:
# https://www.mkdocs.org/user-guide/configuration/#extra
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/langchain-ai/langchain
name: LangChain on GitHub
- icon: fontawesome/brands/slack
link: https://www.langchain.com/join-community
name: LangChain Community Slack
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/LangChainAI
name: LangChain on Twitter / X
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/langchain/
name: LangChain on LinkedIn
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@LangChain
name: LangChain on YouTube
# https://mrkeo.github.io/setup/setting-up-the-footer/#remove-generator
generator: false
Reference in New Issue View Git Blame Copy Permalink