mkdocs-easylinks-plugin 0.1.4__tar.gz → 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/.github/workflows/test.yml +1 -1
  2. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/CHANGELOG.md +12 -0
  3. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/PKG-INFO +8 -10
  4. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/README.md +5 -4
  5. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks_plugin.egg-info/PKG-INFO +8 -10
  6. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/pyproject.toml +4 -7
  7. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/.github/workflows/publish.yml +0 -0
  8. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/.gitignore +0 -0
  9. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/LICENSE +0 -0
  10. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks/__init__.py +0 -0
  11. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks/plugin.py +0 -0
  12. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks_plugin.egg-info/SOURCES.txt +0 -0
  13. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks_plugin.egg-info/dependency_links.txt +0 -0
  14. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks_plugin.egg-info/entry_points.txt +0 -0
  15. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks_plugin.egg-info/requires.txt +0 -0
  16. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/mkdocs_easylinks_plugin.egg-info/top_level.txt +0 -0
  17. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/setup.cfg +0 -0
  18. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/tests/__init__.py +0 -0
  19. {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.1}/tests/test_plugin.py +0 -0
@@ -14,7 +14,7 @@ jobs:
14
14
  runs-on: ubuntu-latest
15
15
  strategy:
16
16
  matrix:
17
- python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
17
+ python-version: ["3.10", "3.11", "3.12", "3.13"]
18
18
 
19
19
  steps:
20
20
  - uses: actions/checkout@v4
@@ -2,6 +2,18 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file.
4
4
 
5
+ ## [0.2.1] - 2026-04-02
6
+
7
+ ### Fixed
8
+ - Replaced deprecated `license = {text = "MIT"}` with SPDX expression `license = "MIT"`
9
+ - Removed deprecated `License :: OSI Approved :: MIT License` classifier
10
+ - Bumped setuptools build requirement to `>=77.0.0` to support SPDX license format
11
+
12
+ ## [0.2.0] - 2026-04-02
13
+
14
+ ### Removed
15
+ - Dropped support for Python 3.8 and 3.9 (both EOL)
16
+
5
17
  ## [0.1.4] - 2026-03-30
6
18
 
7
19
  ### Changed
@@ -1,24 +1,21 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocs-easylinks-plugin
3
- Version: 0.1.4
3
+ Version: 0.2.1
4
4
  Summary: An MkDocs plugin that allows linking to files by filename only
5
5
  Author: Daniel Ferguson
6
- License: MIT
6
+ License-Expression: MIT
7
7
  Project-URL: Homepage, https://github.com/dsferg/mkdocs-easylinks-plugin
8
8
  Project-URL: Documentation, https://github.com/dsferg/mkdocs-easylinks-plugin
9
9
  Project-URL: Repository, https://github.com/dsferg/mkdocs-easylinks-plugin
10
10
  Keywords: mkdocs,plugin,links,cross-references
11
11
  Classifier: Development Status :: 4 - Beta
12
12
  Classifier: Intended Audience :: Developers
13
- Classifier: License :: OSI Approved :: MIT License
14
13
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.8
16
- Classifier: Programming Language :: Python :: 3.9
17
14
  Classifier: Programming Language :: Python :: 3.10
18
15
  Classifier: Programming Language :: Python :: 3.11
19
16
  Classifier: Programming Language :: Python :: 3.12
20
17
  Classifier: Programming Language :: Python :: 3.13
21
- Requires-Python: >=3.8
18
+ Requires-Python: >=3.10
22
19
  Description-Content-Type: text/markdown
23
20
  License-File: LICENSE
24
21
  Requires-Dist: mkdocs>=1.4.0
@@ -42,7 +39,7 @@ An MkDocs plugin that allows you to create cross-references and embed images by
42
39
  - **Link statistics**: See which files are most linked and find orphaned content
43
40
  - **Ambiguity warnings**: Get notified if multiple files share the same name
44
41
  - **Material for MkDocs compatible**: Works seamlessly with Material theme
45
- - **Smart protection**: Code fences and HTML comments are preserved unchanged
42
+ - **Smart protection**: Code fences and HTML comments are preserved unchanged by default (configurable)
46
43
 
47
44
  ## Installation
48
45
 
@@ -186,8 +183,8 @@ Anchors work for document links:
186
183
  - `[text](/absolute/path.md)` - Absolute paths
187
184
  - `[text](../relative/path.md)` - Explicit relative paths with directories
188
185
  - `[text](#anchor)` - Fragment-only links
189
- - Links/images inside code fences (` ``` ` or `~~~`)
190
- - Links/images inside HTML comments (`<!-- -->`)
186
+ - Links/images inside code fences (` ``` ` or `~~~`) — unless `protect_code_fences: false`
187
+ - Links/images inside HTML comments (`<!-- -->`) — unless `protect_html_comments: false`
191
188
 
192
189
  ### Protected Content
193
190
 
@@ -205,7 +202,7 @@ The plugin intelligently ignores links in:
205
202
  <!-- This [link](example.md) won't be processed -->
206
203
  ```
207
204
 
208
- This ensures that example code and commented-out content remain unchanged.
205
+ This ensures that example code and commented-out content remain unchanged. Both behaviours are configurable via `protect_code_fences` and `protect_html_comments`.
209
206
 
210
207
  **Important: Indented Content**
211
208
 
@@ -229,6 +226,7 @@ This design choice ensures the plugin works seamlessly with MkDocs features like
229
226
  **Files that are excluded from mapping:**
230
227
  - Files starting with `.` (dotfiles) - always ignored
231
228
  - Files listed in `ignore_files` configuration - useful for drafts and templates
229
+ - Files in directories listed in `exclude_dirs`
232
230
 
233
231
  ## Using with mkdocs-macros-plugin (Snippets)
234
232
 
@@ -12,7 +12,7 @@ An MkDocs plugin that allows you to create cross-references and embed images by
12
12
  - **Link statistics**: See which files are most linked and find orphaned content
13
13
  - **Ambiguity warnings**: Get notified if multiple files share the same name
14
14
  - **Material for MkDocs compatible**: Works seamlessly with Material theme
15
- - **Smart protection**: Code fences and HTML comments are preserved unchanged
15
+ - **Smart protection**: Code fences and HTML comments are preserved unchanged by default (configurable)
16
16
 
17
17
  ## Installation
18
18
 
@@ -156,8 +156,8 @@ Anchors work for document links:
156
156
  - `[text](/absolute/path.md)` - Absolute paths
157
157
  - `[text](../relative/path.md)` - Explicit relative paths with directories
158
158
  - `[text](#anchor)` - Fragment-only links
159
- - Links/images inside code fences (` ``` ` or `~~~`)
160
- - Links/images inside HTML comments (`<!-- -->`)
159
+ - Links/images inside code fences (` ``` ` or `~~~`) — unless `protect_code_fences: false`
160
+ - Links/images inside HTML comments (`<!-- -->`) — unless `protect_html_comments: false`
161
161
 
162
162
  ### Protected Content
163
163
 
@@ -175,7 +175,7 @@ The plugin intelligently ignores links in:
175
175
  <!-- This [link](example.md) won't be processed -->
176
176
  ```
177
177
 
178
- This ensures that example code and commented-out content remain unchanged.
178
+ This ensures that example code and commented-out content remain unchanged. Both behaviours are configurable via `protect_code_fences` and `protect_html_comments`.
179
179
 
180
180
  **Important: Indented Content**
181
181
 
@@ -199,6 +199,7 @@ This design choice ensures the plugin works seamlessly with MkDocs features like
199
199
  **Files that are excluded from mapping:**
200
200
  - Files starting with `.` (dotfiles) - always ignored
201
201
  - Files listed in `ignore_files` configuration - useful for drafts and templates
202
+ - Files in directories listed in `exclude_dirs`
202
203
 
203
204
  ## Using with mkdocs-macros-plugin (Snippets)
204
205
 
@@ -1,24 +1,21 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocs-easylinks-plugin
3
- Version: 0.1.4
3
+ Version: 0.2.1
4
4
  Summary: An MkDocs plugin that allows linking to files by filename only
5
5
  Author: Daniel Ferguson
6
- License: MIT
6
+ License-Expression: MIT
7
7
  Project-URL: Homepage, https://github.com/dsferg/mkdocs-easylinks-plugin
8
8
  Project-URL: Documentation, https://github.com/dsferg/mkdocs-easylinks-plugin
9
9
  Project-URL: Repository, https://github.com/dsferg/mkdocs-easylinks-plugin
10
10
  Keywords: mkdocs,plugin,links,cross-references
11
11
  Classifier: Development Status :: 4 - Beta
12
12
  Classifier: Intended Audience :: Developers
13
- Classifier: License :: OSI Approved :: MIT License
14
13
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.8
16
- Classifier: Programming Language :: Python :: 3.9
17
14
  Classifier: Programming Language :: Python :: 3.10
18
15
  Classifier: Programming Language :: Python :: 3.11
19
16
  Classifier: Programming Language :: Python :: 3.12
20
17
  Classifier: Programming Language :: Python :: 3.13
21
- Requires-Python: >=3.8
18
+ Requires-Python: >=3.10
22
19
  Description-Content-Type: text/markdown
23
20
  License-File: LICENSE
24
21
  Requires-Dist: mkdocs>=1.4.0
@@ -42,7 +39,7 @@ An MkDocs plugin that allows you to create cross-references and embed images by
42
39
  - **Link statistics**: See which files are most linked and find orphaned content
43
40
  - **Ambiguity warnings**: Get notified if multiple files share the same name
44
41
  - **Material for MkDocs compatible**: Works seamlessly with Material theme
45
- - **Smart protection**: Code fences and HTML comments are preserved unchanged
42
+ - **Smart protection**: Code fences and HTML comments are preserved unchanged by default (configurable)
46
43
 
47
44
  ## Installation
48
45
 
@@ -186,8 +183,8 @@ Anchors work for document links:
186
183
  - `[text](/absolute/path.md)` - Absolute paths
187
184
  - `[text](../relative/path.md)` - Explicit relative paths with directories
188
185
  - `[text](#anchor)` - Fragment-only links
189
- - Links/images inside code fences (` ``` ` or `~~~`)
190
- - Links/images inside HTML comments (`<!-- -->`)
186
+ - Links/images inside code fences (` ``` ` or `~~~`) — unless `protect_code_fences: false`
187
+ - Links/images inside HTML comments (`<!-- -->`) — unless `protect_html_comments: false`
191
188
 
192
189
  ### Protected Content
193
190
 
@@ -205,7 +202,7 @@ The plugin intelligently ignores links in:
205
202
  <!-- This [link](example.md) won't be processed -->
206
203
  ```
207
204
 
208
- This ensures that example code and commented-out content remain unchanged.
205
+ This ensures that example code and commented-out content remain unchanged. Both behaviours are configurable via `protect_code_fences` and `protect_html_comments`.
209
206
 
210
207
  **Important: Indented Content**
211
208
 
@@ -229,6 +226,7 @@ This design choice ensures the plugin works seamlessly with MkDocs features like
229
226
  **Files that are excluded from mapping:**
230
227
  - Files starting with `.` (dotfiles) - always ignored
231
228
  - Files listed in `ignore_files` configuration - useful for drafts and templates
229
+ - Files in directories listed in `exclude_dirs`
232
230
 
233
231
  ## Using with mkdocs-macros-plugin (Snippets)
234
232
 
@@ -1,14 +1,14 @@
1
1
  [build-system]
2
- requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
2
+ requires = ["setuptools>=77.0.0", "wheel", "setuptools_scm[toml]>=6.2"]
3
3
  build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "mkdocs-easylinks-plugin"
7
- version = "0.1.4"
7
+ version = "0.2.1"
8
8
  description = "An MkDocs plugin that allows linking to files by filename only"
9
9
  readme = "README.md"
10
- requires-python = ">=3.8"
11
- license = {text = "MIT"}
10
+ requires-python = ">=3.10"
11
+ license = "MIT"
12
12
  authors = [
13
13
  {name = "Daniel Ferguson"}
14
14
  ]
@@ -16,10 +16,7 @@ keywords = ["mkdocs", "plugin", "links", "cross-references"]
16
16
  classifiers = [
17
17
  "Development Status :: 4 - Beta",
18
18
  "Intended Audience :: Developers",
19
- "License :: OSI Approved :: MIT License",
20
19
  "Programming Language :: Python :: 3",
21
- "Programming Language :: Python :: 3.8",
22
- "Programming Language :: Python :: 3.9",
23
20
  "Programming Language :: Python :: 3.10",
24
21
  "Programming Language :: Python :: 3.11",
25
22
  "Programming Language :: Python :: 3.12",