Skip to content

Commit

Permalink
[update] readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AIboy996 committed May 22, 2024
1 parent dca9517 commit 1108d82
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ include:
---
# mkdocs-ai-summary

[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-ai-summary)](https://pypi.org/project/mkdocs-ai-summary/)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/mkdocs-ai-summary)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-ai-summary)

Generage an **ai-summary** for the page:
![](assets/2024-05-22-22-00-32.png)

Expand All @@ -18,7 +22,7 @@ pip install mkdocs-ai-summary[tongyi]

> Only support [tongyi ai](https://tongyi.aliyun.com/) for now. **Soon to support ChatGPT.**
And you should include the [ai-summary.css](./docs/ai-summary.css)(optional, this is for the **custom admonition style**) in the config file as below:
And you should include the [ai-summary.css](./ai-summary.css)(optional, this is for the **custom admonition style**) in the config file as below:

## Configuration

Expand Down
4 changes: 4 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# mkdocs-ai-summary

[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-ai-summary)](https://pypi.org/project/mkdocs-ai-summary/)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/mkdocs-ai-summary)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-ai-summary)

Generage an **ai-summary** for the page:
![](assets/2024-05-22-22-00-32.png)

Expand Down
7 changes: 5 additions & 2 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,11 @@
<h1 id="mkdocs-ai-summary">mkdocs-ai-summary</h1>
<div class="admonition ai-summary">
<p class="admonition-title">AI摘要 powered by <a href="https://tongyi.aliyun.com/">通义千问</a></p>
<p>The <code>mkdocs-ai-summary</code> plugin generates AI-generated summaries for your documentation using Tongyi AI, soon to support ChatGPT. Install via pip and include <code>ai-summary.css</code>. Configure in <code>mkdocs.yml</code> by adding a meta tag to each page. The plugin caches summaries to prevent redundant API calls, ensuring efficiency. A live demo is available at <a href="https://yangzhang.site">yangzhang.site</a>.</p>
<p><code>mkdocs-ai-summary</code> is a Python package that generates AI-generated summaries for MkDocs pages using Tongyi AI. It supports live demos on <a href="https://yangzhang.site">yangzhang.site</a> and is compatible with Tongyi AI only, soon to include ChatGPT. Install with pip, and include <code>ai-summary.css</code> (optional). Configure in <code>mkdocs.yml</code> by adding meta tags to pages. Caching ensures efficient re-use of summaries when content remains unchanged.</p>
</div>
<p><a href="https://pypi.org/project/mkdocs-ai-summary/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/mkdocs-ai-summary" /></a>
<img alt="PyPI - Implementation" src="https://img.shields.io/pypi/implementation/mkdocs-ai-summary" />
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/mkdocs-ai-summary" /></p>
<p>Generage an <strong>ai-summary</strong> for the page:
<img alt="" src="assets/2024-05-22-22-00-32.png" /></p>
<p>Live demo: <a href="https://yangzhang.site">yangzhang.site</a></p>
Expand All @@ -308,7 +311,7 @@ <h2 id="installation">Installation</h2>
<blockquote>
<p>Only support <a href="https://tongyi.aliyun.com/">tongyi ai</a> for now. <strong>Soon to support ChatGPT.</strong></p>
</blockquote>
<p>And you should include the <a href="./docs/ai-summary.css">ai-summary.css</a>(optional, this is for the <strong>custom admonition style</strong>) in the config file as below:</p>
<p>And you should include the <a href="ai-summary.css">ai-summary.css</a>(optional, this is for the <strong>custom admonition style</strong>) in the config file as below:</p>
<h2 id="configuration">Configuration</h2>
<p>A demo for <code>mkdocs.yml</code>:</p>
<div class="highlight"><pre><span></span><code>site_name: mkdocs-ai-summary
Expand Down

0 comments on commit 1108d82

Please sign in to comment.