ewen/rudibridge-mirror
1
0
Fork 0
mirror of https://codeberg.org/Ewen/rudibridge.git synced 2024-10-22 09:11:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: readme format

Browse source
This commit is contained in:
Ewen 2024-05-12 11:28:55 +02:00
parent 7f2cbe82b1
commit 3e3879e48e
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -13,20 +13,20 @@ This project consists of two parts :
### Parameters ### Parameters
- `**url**` (required): the URL of the page - `url` (required): the URL of the page
- `**article**` (required): the HTML tag encapsulating a feed item - `article` (required): the HTML tag encapsulating a feed item
- `**title**` (required): the HTML tag of the article title - `title` (required): the HTML tag of the article title
- `**articleClass**`: a class name helping to filter the article element - `articleClass`: a class name helping to filter the article element
- `**titleClass**`: a class name helping to filter the title element - `titleClass`: a class name helping to filter the title element
- `**section**`: the HTML tag encapsulating the group of items. If not given, the entire page will be used - `section`: the HTML tag encapsulating the group of items. If not given, the entire page will be used
- `**content**`: the HTML tag encapsulating the content, or description, of the item. The default is `p` - `content`: the HTML tag encapsulating the content, or description, of the item. The default is `p`
- `**contentClass**`: a class name helping to filter the content element - `contentClass`: a class name helping to filter the content element
- `**link**`: the HTML tag encapsulating the link to the item. The default is `a`. - `link`: the HTML tag encapsulating the link to the item. The default is `a`.
- `**linkClass**`: a class name helping to filter the link element - `linkClass`: a class name helping to filter the link element
- `**datetime**`: the HTML tag encapsulating the date and time of the item. Any date and time format can be used, the parser will try to understand the format. - `datetime`: the HTML tag encapsulating the date and time of the item. Any date and time format can be used, the parser will try to understand the format.
- `**datetimeClass**`: a class name helping to filter the datetime element - `datetimeClass`: a class name helping to filter the datetime element
- `**author**`: the HTML tag encapsulating the author of the item - `author`: the HTML tag encapsulating the author of the item
- `**authorClass**`: a class name helping to filter the author element - `authorClass`: a class name helping to filter the author element
## Installation ## Installation