You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+70-60Lines changed: 70 additions & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,41 +17,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
17
17
18
18
-->
19
19
20
+
## 1.5.0 - 2022-10-13
21
+
22
+
### Added
23
+
24
+
* Feature: ignore pages with draft:true in meta by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/149>
25
+
26
+
### Changed
27
+
28
+
* Require tzdata only on Windows by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/148>
29
+
20
30
## 1.4.1 - 2022-10-07
21
31
22
32
### Changed
23
33
24
-
- Set Mkdocs upper cap to major version by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/146> to comply with the discussion opened by @oprypin in #137
34
+
* Set Mkdocs upper cap to major version by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/146> to comply with the discussion opened by @oprypin in #137
25
35
26
36
## 1.4.0 - 2022-10-07
27
37
28
38
### Added
29
39
30
-
- Feature: add default_time option by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/145>
40
+
* Feature: add default_time option by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/145>
31
41
32
42
### Changed
33
43
34
-
- Minor improvments: clean unused imports, lines length and use fstrings in logging by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/143>
35
-
- Improvment: more granular fallback to build timestamp by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/144>
44
+
* Minor improvments: clean unused imports, lines length and use fstrings in logging by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/143>
45
+
* Improvment: more granular fallback to build timestamp by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/144>
36
46
37
47
## 1.3.0 - 2022-10-07
38
48
39
49
### Added
40
50
41
-
- Feature: add option to set default timezone by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/142>
51
+
* Feature: add option to set default timezone by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/142>
42
52
43
53
## 1.2.0 - 2022-10-03
44
54
45
55
### Changed
46
56
47
-
- compatibility with Mkdocs 1.4
48
-
- dependencies update
57
+
* compatibility with Mkdocs 1.4
58
+
* dependencies update
49
59
50
60
## 1.1.0 - 2022-04-27
51
61
52
62
### Changed
53
63
54
-
- switched license to MIT. (See #117)
64
+
* switched license to MIT. (See #117)
55
65
56
66
## 1.0.0 - 2022-03-31
57
67
@@ -60,258 +70,258 @@ So, no feature in this release, just focusing on quality and code cleanliness.
60
70
61
71
### Added
62
72
63
-
- Unit tests to reach a 80% coverage score
73
+
* Unit tests to reach a 80% coverage score
64
74
65
75
### Changed
66
76
67
-
- Supported Mkdocs versions range increased to `mkdocs>=1.1,<1.4`
77
+
* Supported Mkdocs versions range increased to `mkdocs>=1.1,<1.4`
68
78
69
79
### Fixed
70
80
71
-
- Minor bugs fixes
72
-
- Minor documentation improvments
81
+
* Minor bugs fixes
82
+
* Minor documentation improvments
73
83
74
84
----
75
85
76
86
## 0.21.0 - 2022-02-10
77
87
78
88
### Added
79
89
80
-
- JSON Schema for configuration validation
81
-
- compatible with Python 3.10
90
+
* JSON Schema for configuration validation
91
+
* compatible with Python 3.10
82
92
83
93
----
84
94
85
95
## 0.20.1 - 2022-02-08
86
96
87
97
### Fixed
88
98
89
-
- Error when using "enabled: false" together with "match_path" (see #104 - PR #107). Reported by @prcr, fixed by @dcode. Thanks to them!
99
+
* Error when using "enabled: false" together with "match_path" (see #104 - PR #107). Reported by @prcr, fixed by @dcode. Thanks to them!
90
100
91
101
----
92
102
93
103
## 0.20.0 - 2022-01-06
94
104
95
105
### Added
96
106
97
-
- option to enable/disable the plugin, for example through an environment variable (default: enabled). See: PR #103, [related doc section](https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin)
107
+
* option to enable/disable the plugin, for example through an environment variable (default: enabled). See: PR #103, [related doc section](https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin)
98
108
99
109
### Changed
100
110
101
-
- CI: Python version used to build and publish package is now 3.9
111
+
* CI: Python version used to build and publish package is now 3.9
102
112
103
113
### Removed
104
114
105
-
- support for Python 3.6 (EOL)
115
+
* support for Python 3.6 (EOL)
106
116
107
117
----
108
118
109
119
## 0.19.1 - 2021-10-04
110
120
111
121
### Fixed
112
122
113
-
- Fix #95: introduced logic did not handle case where categories meta keys are not defined
123
+
* Fix #95: introduced logic did not handle case where categories meta keys are not defined
114
124
115
125
----
116
126
117
127
## 0.19.0 - 2021-10-02
118
128
119
129
### Added
120
130
121
-
- new option to include [RSS `<category>` item element](https://www.w3schools.com/xml/rss_tag_category_item.asp) using page metadata (YAML frontmatter). It's customizable to get custom meta keys for keywords/tags. PR [#4](https://github.com/Guts/mkdocs-rss-plugin/pull/4)
131
+
* new option to include [RSS `<category>` item element](https://www.w3schools.com/xml/rss_tag_category_item.asp) using page metadata (YAML frontmatter). It's customizable to get custom meta keys for keywords/tags. PR [#4](https://github.com/Guts/mkdocs-rss-plugin/pull/4)
122
132
123
133
----
124
134
125
135
## 0.18.0 - 2021-09-20
126
136
127
137
### Added
128
138
129
-
- option to get the full page content into thed. Contributed by [liang2kl](https://github.com/liang2kl) with [PR 88](https://github.com/Guts/mkdocs-rss-plugin/pull/88). See the [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-description-length).
139
+
* option to get the full page content into thed. Contributed by [liang2kl](https://github.com/liang2kl) with [PR 88](https://github.com/Guts/mkdocs-rss-plugin/pull/88). See the [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-description-length).
130
140
131
141
### Changed
132
142
133
-
- documentation on ReadTheDocs has been removed to reduce confusion and dependencies. [PR #89](https://github.com/Guts/mkdocs-rss-plugin/pull/89).
143
+
* documentation on ReadTheDocs has been removed to reduce confusion and dependencies. [PR #89](https://github.com/Guts/mkdocs-rss-plugin/pull/89).
134
144
135
145
----
136
146
137
147
## 0.17.0 - 2021-06-14
138
148
139
149
### Changed
140
150
141
-
- bump MkDocs maximal version
151
+
* bump MkDocs maximal version
142
152
143
153
### Fixed
144
154
145
-
- improve DockerFile used to test, fixing it after Material removed some dependencies
155
+
* improve DockerFile used to test, fixing it after Material removed some dependencies
146
156
147
157
----
148
158
149
159
## 0.16.1
150
160
151
161
### Fixed
152
162
153
-
- remove a print statement
163
+
* remove a print statement
154
164
155
165
----
156
166
157
167
## 0.16.0
158
168
159
169
### Added
160
170
161
-
- add option to handle the [RSS item comments element](https://www.w3schools.com/XML/rss_tag_comments.asp) through item URL path (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-comments-path))
171
+
* add option to handle the [RSS item comments element](https://www.w3schools.com/XML/rss_tag_comments.asp) through item URL path (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-comments-path))
162
172
163
173
### Changed
164
174
165
-
- ignore `urllib.error.URLError` exception to avoid build crashes typically when network is offline
175
+
* ignore `urllib.error.URLError` exception to avoid build crashes typically when network is offline
166
176
167
177
----
168
178
169
179
## 0.15.0
170
180
171
181
### Added
172
182
173
-
- ability to define URL parameters on items URLs (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#url-parameters))
174
-
- complete unit tests and display code coverage badge (using codecov.io)
183
+
* ability to define URL parameters on items URLs (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#url-parameters))
184
+
* complete unit tests and display code coverage badge (using codecov.io)
175
185
176
186
### Changed
177
187
178
-
- homogenization of docstrings on the sphinx format (as stipulated in the contribution guidelines)
188
+
* homogenization of docstrings on the sphinx format (as stipulated in the contribution guidelines)
179
189
180
190
----
181
191
182
192
## 0.14.0
183
193
184
194
### Fixed
185
195
186
-
- fix `match_path` option by skipping the pages that aren't included. See [PR #49](https://github.com/Guts/mkdocs-rss-plugin/pull/49). Contributed by [Paulo Ribeiro](https://github.com/pauloribeiro-codacy/).
196
+
* fix `match_path` option by skipping the pages that aren't included. See [PR #49](https://github.com/Guts/mkdocs-rss-plugin/pull/49). Contributed by [Paulo Ribeiro](https://github.com/pauloribeiro-codacy/).
187
197
188
198
### Added
189
199
190
-
- add isort to development toolbelt
200
+
* add isort to development toolbelt
191
201
192
202
----
193
203
194
204
## 0.13.0
195
205
196
206
### Added
197
207
198
-
- if `page.meta.description` is not set, the `abstract_chars_count` first characters from markdown content are now converted into HTML.
199
-
- add `match_path` option which should be a regex pattern matching the path to your files within the docs_dir. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34) and the related [PR #43](https://github.com/Guts/mkdocs-rss-plugin/pull/43). Contributed by [Ryan Morshead](https://github.com/rmorshea/).
208
+
* if `page.meta.description` is not set, the `abstract_chars_count` first characters from markdown content are now converted into HTML.
209
+
* add `match_path` option which should be a regex pattern matching the path to your files within the docs_dir. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34) and the related [PR #43](https://github.com/Guts/mkdocs-rss-plugin/pull/43). Contributed by [Ryan Morshead](https://github.com/rmorshea/).
200
210
201
211
----
202
212
203
213
## 0.12.0
204
214
205
215
### Added
206
216
207
-
- add support to `page.meta.authors` or `page.meta.author` to populate feed items author tag. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34).
217
+
* add support to `page.meta.authors` or `page.meta.author` to populate feed items author tag. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34).
208
218
209
219
----
210
220
211
221
## 0.11.0
212
222
213
223
### Added
214
224
215
-
- option to prettify the output, disabling minify. See [issue #18](https://github.com/Guts/mkdocs-rss-plugin/issues/18), [PR #33](https://github.com/Guts/mkdocs-rss-plugin/pull/33) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#prettified-output)
225
+
* option to prettify the output, disabling minify. See [issue #18](https://github.com/Guts/mkdocs-rss-plugin/issues/18), [PR #33](https://github.com/Guts/mkdocs-rss-plugin/pull/33) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#prettified-output)
216
226
217
227
### Changed
218
228
219
-
- By default, the output file is now minified.
229
+
* By default, the output file is now minified.
220
230
221
231
----
222
232
223
233
## 0.10.0
224
234
225
235
### Added
226
236
227
-
- option to use dates from page metadata (YAML front-matter) instead of git log. See [#14](https://github.com/Guts/mkdocs-rss-plugin/pull/14) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#dates-overriding)
228
-
- Python 3.9 is enabled in CI and referenced in PyPi tags
237
+
* option to use dates from page metadata (YAML front-matter) instead of git log. See [#14](https://github.com/Guts/mkdocs-rss-plugin/pull/14) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#dates-overriding)
238
+
* Python 3.9 is enabled in CI and referenced in PyPi tags
229
239
230
240
### Changed
231
241
232
-
- the default length for description has been changed from 150 to 160 to fit maximum recommendation
242
+
* the default length for description has been changed from 150 to 160 to fit maximum recommendation
233
243
234
244
----
235
245
236
246
## 0.9.0
237
247
238
248
### Improved
239
249
240
-
- enable auto-escape on feed and item titles, using the Jinja e filter - see #19
241
-
- improve consistency for missing attributes in mkdocs.yml, returning almost always a None value
250
+
* enable auto-escape on feed and item titles, using the Jinja e filter - see #19
251
+
* improve consistency for missing attributes in mkdocs.yml, returning almost always a None value
242
252
243
253
----
244
254
245
255
## 0.8.0
246
256
247
257
### Added
248
258
249
-
- RSS compliance: image length is now present into enclosure tags - See #9
250
-
- User documentation:
251
-
- clarify how item elements are computed
252
-
- add how to edit HTML templates meta-tags to reference feeds
253
-
- API reference documentation generated from source code and published through Read The Docs
259
+
* RSS compliance: image length is now present into enclosure tags - See #9
260
+
* User documentation:
261
+
* clarify how item elements are computed
262
+
* add how to edit HTML templates meta-tags to reference feeds
263
+
* API reference documentation generated from source code and published through Read The Docs
254
264
255
265
----
256
266
257
267
## 0.7.2
258
268
259
269
### Fixed
260
270
261
-
- wrong items order in updated feed
271
+
* wrong items order in updated feed
262
272
263
273
----
264
274
265
275
## 0.7.1
266
276
267
277
### Fixed
268
278
269
-
- feed for updated content is broken - #15
279
+
* feed for updated content is broken - #15
270
280
271
281
----
272
282
273
283
## 0.7.0
274
284
275
285
### Added
276
286
277
-
- plugin: add the `language` tag to the channel
278
-
- tooling:
279
-
- add first unit tests and code coverage
280
-
- add Github Action to perform tests
281
-
- check docker build using mkdocs-material
287
+
* plugin: add the `language` tag to the channel
288
+
* tooling:
289
+
* add first unit tests and code coverage
290
+
* add Github Action to perform tests
291
+
* check docker build using mkdocs-material
282
292
283
293
### Changed
284
294
285
-
- docs: switch Feedly images from HTTP to HTTPS
295
+
* docs: switch Feedly images from HTTP to HTTPS
286
296
287
297
----
288
298
289
299
## 0.6.1
290
300
291
301
### Fixed
292
302
293
-
- remove print from plugin code
303
+
* remove print from plugin code
294
304
295
305
----
296
306
297
307
## 0.6.0
298
308
299
309
### Added
300
310
301
-
- plugin: add tag `guid` to the feed's items (using the page URL)
311
+
* plugin: add tag `guid` to the feed's items (using the page URL)
302
312
303
313
### Changed
304
314
305
-
- docs: minor improvments
315
+
* docs: minor improvments
306
316
307
317
----
308
318
309
319
## 0.5.0
310
320
311
321
### Added
312
322
313
-
- plugin: handle channel `image` and items (entries) `enclosure`
323
+
* plugin: handle channel `image` and items (entries) `enclosure`
314
324
315
325
### Changed
316
326
317
-
- plugin: refactoring to build feed entry through a method
327
+
* plugin: refactoring to build feed entry through a method
0 commit comments