Skip to main content

A Material for MkDocs plugin that adds a Gemini-powered chat window to documentation pages

Project description

Requirements: As a user, I can use a chat window to ask questions about the documentation on the Material for MkDocs project. UX Features:

  • The chat window should be able to use the chat history.
  • The chat window should be able to use the chat context.
  • The chat windows should use Gemini 2.5 Pro as the LLM.
  • The chat window should allow follow up questions.
  • The chat window should allow the user to specify the file path to the documentation.
  • The chat window should allow the user to specify the language of the documentation.
  • The chat window should allow the user to specify the version of the documentation.
  • The chat window should allow the user to copy the output to the clipboard.
  • The chat window should allow the user to download the output as a file.

Implementation:

  • The implementation should be done as a Material for MkDocs plugin.
  • The plugin should be able to be added to the documentation site by adding it to the mkdocs.yml file.
  • The plugin should allow the user to specify where the UI box should be placed in the documentation site.

References: https://deepwiki.com https://www.deepseek.com/chat/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_gemini_chat-0.1.0.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_gemini_chat-0.1.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_gemini_chat-0.1.0.tar.gz.

File metadata

  • Download URL: mkdocs_gemini_chat-0.1.0.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for mkdocs_gemini_chat-0.1.0.tar.gz
Algorithm Hash digest
SHA256 502c321af9cc3405e47aff11e82f80086dbb273d5d9d2125c327be5b378978b6
MD5 68350a1c607c50f40a466a1135363f6d
BLAKE2b-256 1e67e6d1df5e5ddda2a97265c4675852654e40704684095b243e01f537a96170

See more details on using hashes here.

File details

Details for the file mkdocs_gemini_chat-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_gemini_chat-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dcc1e2c559b82f4de0cdc1b2e6d1ecc0c6749f18f6d45c959d1b5940760adcca
MD5 18ceeeb3d606a21f79026f6adf9633b5
BLAKE2b-256 d4e6a2abb4fc9d4a15f0c9a09f50224f51eecf3ae2f66c752b401980bad94222

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page