Metadata-Version: 2.1
Name: sphinxcontrib-del-marker
Version: 0.1.2
Summary: A sphinx plugin that enables embedding of HTML5 del
Author-Email: jennier0107 <mt3085570450@outlook.com>
License: MIT
Requires-Python: >=3.11
Requires-Dist: Sphinx>=7.3.7
Requires-Dist: sphinxcontrib-serializinghtml>=1.1.10
Description-Content-Type: text/markdown

# sphinxcontrib-del-marker

The `del-marker` extension allows you to use texts as defined by the HTML5 standard. 

It's a wrapper around the `<del>` tag. 

using a simple directive as:

```rst
.. del:: some_text here
```

will be rendered as:

```html
<del>some_text here</del>
```

## Usage

### Install
You can install with pip:

```bash
pip install sphinxcontrib-del-marker
```

### Configure
and add it to `sphinx conf.py`:

```python
# conf.py
...
extensions = ["sphinxcontrib_del_marker"]
...
```

### Use

with directive:
```rst
.. del:: lorem lorem lorem
```


## Roadmap

- [ ] using with sphinx `role`