{"id":15107054,"url":"https://github.com/aiboy996/mkdocs-ai-summary","last_synced_at":"2025-10-24T06:08:52.871Z","repository":{"id":241124284,"uuid":"804400410","full_name":"AIboy996/mkdocs-ai-summary","owner":"AIboy996","description":"A mkdocs plugin to generage summary with the help of AI.","archived":false,"fork":false,"pushed_at":"2024-12-27T17:48:11.000Z","size":1739,"stargazers_count":9,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-28T14:28:30.451Z","etag":null,"topics":["chatgpt-api","mkdocs","mkdocs-plugin","summarytools","tongyiqianwen"],"latest_commit_sha":null,"homepage":"https://aiboy996.github.io/mkdocs-ai-summary/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AIboy996.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-22T14:11:24.000Z","updated_at":"2025-09-23T04:55:51.000Z","dependencies_parsed_at":"2024-05-28T16:54:46.086Z","dependency_job_id":null,"html_url":"https://github.com/AIboy996/mkdocs-ai-summary","commit_stats":{"total_commits":13,"total_committers":2,"mean_commits":6.5,"dds":0.07692307692307687,"last_synced_commit":"5e3a3d0e77c422c1d408b657e3c2348777b32b6b"},"previous_names":["aiboy996/mkdocs-ai-summary"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AIboy996/mkdocs-ai-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AIboy996%2Fmkdocs-ai-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AIboy996%2Fmkdocs-ai-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AIboy996%2Fmkdocs-ai-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AIboy996%2Fmkdocs-ai-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AIboy996","download_url":"https://codeload.github.com/AIboy996/mkdocs-ai-summary/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AIboy996%2Fmkdocs-ai-summary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280546390,"owners_count":26348719,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-22T02:00:06.515Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt-api","mkdocs","mkdocs-plugin","summarytools","tongyiqianwen"],"created_at":"2024-09-25T21:04:06.865Z","updated_at":"2025-10-24T06:08:52.819Z","avatar_url":"https://github.com/AIboy996.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-ai-summary\n\n[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-ai-summary)](https://pypi.org/project/mkdocs-ai-summary/)\n![PyPI - Implementation](https://img.shields.io/pypi/implementation/mkdocs-ai-summary)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-ai-summary)\n\nGenerage an **ai-summary** and insert into page content:\n![](assets/2024-05-23-04-35-01.png)\n\n## Live Demo\n\nMinimal demo(raw mkdocs): [AIboy996/mkdocs-ai-summary-minimal-example](https://aiboy996.github.io/mkdocs-ai-summary-minimal-example/)\n\nAnother demo(mkdocs-material theme): [AIboy996/mkdocs-ai-summary](https://aiboy996.github.io/mkdocs-ai-summary)\n\nReal world demo(my homepage): [yangzhang.site](https://yangzhang.site)\n\n\u003e I wrote these codes for my blog site at first. Now it's open for anyone who may need AI to summarize his words.\n\n## Installation\n\nYou should install the package with pip:\n```\npip install mkdocs-ai-summary[chatgpt]\n# this will install `openai` additionally\n```\nor\n```\npip install mkdocs-ai-summary[tongyi]\n# this will install `dashscope` additionally\n```\n\n\u003e [!WARNING]\n\u003e \n\u003e Only support [ChatGPT](https://chat.openai.com/) and [tongyi ai](https://tongyi.aliyun.com/) for now.\n\u003e  \n\u003e  To use **ChatGPT(default)**, you should set a Environmental Variable for **api key**:\n\u003e  ```bash\n\u003e  export OPENAI_API_KEY='sk-xxxxxxx'\n\u003e  ```\n\u003e [how to get an OPENAI_API_KEY?](https://platform.openai.com/docs/quickstart)\n\u003e \n\u003e  To use **tongyi ai**, you should set a Environmental Variable for **api key**:\n\u003e  ```bash\n\u003e  export DASHSCOPE_API_KEY='sk-xxxxxxx'\n\u003e  ```\n\u003e [how to get an DASHSCOPE_API_KEY?](https://dashscope.console.aliyun.com/)\n\n\u003e [!TIP] \n\u003e \n\u003e Furthermore you can include the [ai-summary.css](./docs/ai-summary.css) as `extra_css` in the config file.\n\u003e \n\u003e This is optional, and iff you are using `mkdocs-material` theme this can work.\n\n## Configuration\n\nAll parameters:\n\nname|type|default value| note\n--|--|--|--\napi|str|chatgpt| only support chatgpt or tongyi\nmodel|str|gpt-3.5-turbo | -\nignore_code|bool|true| ignore code block in markdown\ncache|bool|true| -\ncache_dir|str|\"./\"| -\nprompt|str|\"Please help me summarize the following content into an abstract within 200 words: \"| -\n\n\n### Example Configuration For ChatGPT Summary\n\nSetup `mkdocs.yml` like this:\n\n```yml\nsite_name: mkdocs-ai-summary\ntheme:\n  name: material\n\nplugins:\n  # use default config\n  - ai-summary\n  - tags\n\nmarkdown_extensions:\n  - admonition\n  - pymdownx.details\n  - pymdownx.superfences\n  - pymdownx.tabbed:\n      alternate_style: true \nextra_css:\n  - ai-summary.css\n```\n\nThen for the page you want an ai-summary, just add a meta tag:\n```markdown\n---\ninclude:\n- ai-summary\n---\n\n# title\n\nhello ai summary.\n```\n\n### Example Configuration For tongyi ai Summary\nor you can use **tongyi ai** by setting:\n```yml\nplugins:\n  - ai-summary:\n      api: \"tongyi\"\n      model: \"qwen-turbo\"\n      ignore_code: true\n      cache: true\n      cache_dir: \"./\"\n      prompt: \"Please help me summarize the following content into an abstract within 200 words: \"\n```\n\n### Setup ai-summary for specific page\n\nYou can also setup ai summary for each page separately:\n\n```markdown\n---\ninclude:\n- ai-summary\nai-summary-config:\n    api: \"tongyi\"\n    model: \"qwen-turbo\"\n    prompt: \"Say anything, 200 words.\"\n---\n\n# title\n\nhello ai summary.\n```\n\nall config options are available. **Page configuration will override unified configuration.**\n\n## About Cache\n\nDon'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.\n\nEnjoy it.\n\n## SPECIAL THANKS TO\n\n- [mkdocs](https://www.mkdocs.org/)\n- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiboy996%2Fmkdocs-ai-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faiboy996%2Fmkdocs-ai-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiboy996%2Fmkdocs-ai-summary/lists"}