https://github.com/aiboy996/mkdocs-ai-summary
A mkdocs plugin to generage summary with the help of AI.
https://github.com/aiboy996/mkdocs-ai-summary
chatgpt-api mkdocs mkdocs-plugin summarytools tongyiqianwen
Last synced: 3 months ago
JSON representation
A mkdocs plugin to generage summary with the help of AI.
- Host: GitHub
- URL: https://github.com/aiboy996/mkdocs-ai-summary
- Owner: AIboy996
- License: mit
- Created: 2024-05-22T14:11:24.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-05-28T13:28:14.000Z (11 months ago)
- Last Synced: 2024-10-29T20:19:13.414Z (6 months ago)
- Topics: chatgpt-api, mkdocs, mkdocs-plugin, summarytools, tongyiqianwen
- Language: HTML
- Homepage: https://aiboy996.github.io/mkdocs-ai-summary/
- Size: 1.26 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-ai-summary
[](https://pypi.org/project/mkdocs-ai-summary/)
Generage an **ai-summary** and insert into page content:
## Live Demo
Minimal demo(raw mkdocs): [AIboy996/mkdocs-ai-summary-minimal-example](https://aiboy996.github.io/mkdocs-ai-summary-minimal-example/)
Another demo(mkdocs-material theme): [AIboy996/mkdocs-ai-summary](https://aiboy996.github.io/mkdocs-ai-summary)
Real world demo(my homepage): [yangzhang.site](https://yangzhang.site)
> I wrote these codes for my blog site at first. Now it's open for anyone who may need AI to summarize his words.
## Installation
You should install the package with pip:
```
pip install mkdocs-ai-summary[chatgpt]
# this will install `openai` additionally
```
or
```
pip install mkdocs-ai-summary[tongyi]
# this will install `dashscope` additionally
```
> [!WARNING]
>
> Only support [ChatGPT](https://chat.openai.com/) and [tongyi ai](https://tongyi.aliyun.com/) for now.
>
> To use **ChatGPT(default)**, you should set a Environmental Variable for **api key**:
> ```bash
> export OPENAI_API_KEY='sk-xxxxxxx'
> ```
> [how to get an OPENAI_API_KEY?](https://platform.openai.com/docs/quickstart)
>
> To use **tongyi ai**, you should set a Environmental Variable for **api key**:
> ```bash
> export DASHSCOPE_API_KEY='sk-xxxxxxx'
> ```
> [how to get an DASHSCOPE_API_KEY?](https://dashscope.console.aliyun.com/)
> [!TIP]
>
> Furthermore you can include the [ai-summary.css](./docs/ai-summary.css) as `extra_css` in the config file.
>
> This is optional, and iff you are using `mkdocs-material` theme this can work.
## Configuration
All parameters:
name|type|default value| note
--|--|--|--
api|str|chatgpt| only support chatgpt or tongyi
model|str|gpt-3.5-turbo | -
ignore_code|bool|true| ignore code block in markdown
cache|bool|true| -
cache_dir|str|"./"| -
prompt|str|"Please help me summarize the following content into an abstract within 200 words: "| -
### Example Configuration For ChatGPT Summary
Setup `mkdocs.yml` like this:
```yml
site_name: mkdocs-ai-summary
theme:
name: material
plugins:
# use default config
- ai-summary
- tags
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
extra_css:
- ai-summary.css
```
Then for the page you want an ai-summary, just add a meta tag:
```markdown
---
include:
- ai-summary
---
# title
hello ai summary.
```
### Example Configuration For tongyi ai Summary
or you can use **tongyi ai** by setting:
```yml
plugins:
- ai-summary:
api: "tongyi"
model: "qwen-turbo"
ignore_code: true
cache: true
cache_dir: "./"
prompt: "Please help me summarize the following content into an abstract within 200 words: "
```
### Setup ai-summary for specific page
You can also setup ai summary for each page separately:
```markdown
---
include:
- ai-summary
ai-summary-config:
api: "tongyi"
model: "qwen-turbo"
prompt: "Say anything, 200 words."
---
# title
hello ai summary.
```
all config options are available. **Page configuration will override unified configuration.**
## 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.
## SPECIAL THANKS TO
- [mkdocs](https://www.mkdocs.org/)
- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)