Skip to content

Commit

Permalink
update README*2
Browse files Browse the repository at this point in the history
  • Loading branch information
un4gt committed Jun 13, 2024
1 parent 269d854 commit e1f9a56
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,34 @@ 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`

0 comments on commit e1f9a56

Please sign in to comment.