mkdocs-ai-summary 0.2.1

A mkdocs plugin to generage summary with the help of AI.

mkdocs-ai-summary

Generage an ai-summary for the page:

Minimal demo: aiboy996.github.io/mkdocs-ai-summary

Live demo(my homepage): yangzhang.site

Installation

You should install the package with pip:

pip install mkdocs-ai-summary[chatgpt]

or

pip install mkdocs-ai-summary[tongyi]

⚠️⚠️⚠️⚠️

Only support ChatGPT and tongyi ai for now.

To use ChatGPT(default), you should set a Environmental Variable for api key:

export OPENAI_API_KEY='sk-xxxxxxx'

how to get an OPENAI_API_KEY?

To use tongyi ai, you should set a Environmental Variable for api key:

export DASHSCOPE_API_KEY='sk-xxxxxxx'

how to get an DASHSCOPE_API_KEY?

[optional] Then you can include the ai-summary.css(optional, this is for the custom ai summary admonition style) in the config file as below:

Configuration

A demo for mkdocs.yml:

site_name: mkdocs-ai-summary
theme:
  name: material

plugins:
  - ai-summary:
      # these are all default value
      api: "chatgpt"
      model: "gpt-3.5-turbo"
      # we ignore ``` code block when do summary
      ignore_code: true 
      cache: true
      cache_dir: "./"
      prompt: "请帮我把下面的内容总结为200字以内的摘要："
  - tags

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
extra_css:
  - ai-summary.css

Then for each page you can add the ai-summary with a meta tag:

---
include:
- ai-summary
---

# h1

....

or you can use tongyi ai by setting:

plugins:
  - ai-summary:
      api: "tongyi"
      ignore_code: true
      cache: true
      cache_dir: "./"
      prompt: "请帮我把下面的内容总结为200字以内的摘要："

About Cache

Don't worry about duplicate api calls, we've made the cache function so that if you've done an ai-summary before and the content hasn't changed it will use the cache.

Enjoy it.