Metadata-Version: 2.3
Name: sphinxcontrib-friendlinks
Version: 0.1.1
Summary: A Sphinx extension for rendering beautiful friend link cards
Keywords: sphinx,sphinx-extension,friendlinks,blogroll,documentation
Author: un4gt
Author-email: un4gt <mt3085570450@outlook.com>
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Requires-Dist: sphinx>=7.1.2
Maintainer: un4gt
Maintainer-email: un4gt <mt3085570450@outlook.com>
Requires-Python: >=3.8
Project-URL: Homepage, https://github.com/un4gt/sphinxcontrib-friendlinks
Project-URL: Issues, https://github.com/un4gt/sphinxcontrib-friendlinks/issues
Project-URL: Repository, https://github.com/un4gt/sphinxcontrib-friendlinks
Description-Content-Type: text/markdown

# sphinxcontrib-friendlinks

A Sphinx extension for rendering beautiful friend link cards in your documentation.

## Installation

```bash
pip install sphinxcontrib-friendlinks
```

## Usage

Add the extension to your `conf.py`:

```python
extensions = [
    'sphinxcontrib.friendlinks',
]
```

Then use the `friendlink` directive in your reStructuredText files:

```rst
.. friendlink::
   :name: Example Site
   :link: https://example.com
   :avatar: https://example.com/avatar.png
   :descr: This is an example site description
   :siteshot: https://example.com/screenshot.png
   :rss: https://example.com/rss.xml
```

## Options

| Option | Required | Description |
|--------|----------|-------------|
| `name` | Yes | Site name |
| `link` | Yes | Site URL |
| `avatar` | Yes | Avatar image URL |
| `descr` | Yes | Site description |
| `siteshot` | No | Site screenshot URL |
| `rss` | No | RSS feed URL |

## Features

- Clean card-style layout with avatar, name, description
- Optional site screenshot display
- RSS link with icon
- Responsive design for mobile devices
- Dark mode support (`prefers-color-scheme`)
- XSS protection for user input

## Example

![Friend Link Card Example](https://raw.githubusercontent.com/un4gt/sphinxcontrib-friendlinks/main/docs/_build/html/_static/example.png)

## License

MIT
