mkdocs-easylinks-plugin 0.1.4__tar.gz → 0.2.0__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.
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/.github/workflows/test.yml +1 -1
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/CHANGELOG.md +5 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/PKG-INFO +7 -8
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/README.md +5 -4
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks_plugin.egg-info/PKG-INFO +7 -8
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/pyproject.toml +2 -4
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/.github/workflows/publish.yml +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/.gitignore +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/LICENSE +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks/__init__.py +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks/plugin.py +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks_plugin.egg-info/SOURCES.txt +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks_plugin.egg-info/dependency_links.txt +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks_plugin.egg-info/entry_points.txt +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks_plugin.egg-info/requires.txt +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks_plugin.egg-info/top_level.txt +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/setup.cfg +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/tests/__init__.py +0 -0
- {mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/tests/test_plugin.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mkdocs-easylinks-plugin
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.2.0
|
|
4
4
|
Summary: An MkDocs plugin that allows linking to files by filename only
|
|
5
5
|
Author: Daniel Ferguson
|
|
6
6
|
License: MIT
|
|
@@ -12,13 +12,11 @@ Classifier: Development Status :: 4 - Beta
|
|
|
12
12
|
Classifier: Intended Audience :: Developers
|
|
13
13
|
Classifier: License :: OSI Approved :: MIT License
|
|
14
14
|
Classifier: Programming Language :: Python :: 3
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
17
15
|
Classifier: Programming Language :: Python :: 3.10
|
|
18
16
|
Classifier: Programming Language :: Python :: 3.11
|
|
19
17
|
Classifier: Programming Language :: Python :: 3.12
|
|
20
18
|
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
-
Requires-Python: >=3.
|
|
19
|
+
Requires-Python: >=3.10
|
|
22
20
|
Description-Content-Type: text/markdown
|
|
23
21
|
License-File: LICENSE
|
|
24
22
|
Requires-Dist: mkdocs>=1.4.0
|
|
@@ -42,7 +40,7 @@ An MkDocs plugin that allows you to create cross-references and embed images by
|
|
|
42
40
|
- **Link statistics**: See which files are most linked and find orphaned content
|
|
43
41
|
- **Ambiguity warnings**: Get notified if multiple files share the same name
|
|
44
42
|
- **Material for MkDocs compatible**: Works seamlessly with Material theme
|
|
45
|
-
- **Smart protection**: Code fences and HTML comments are preserved unchanged
|
|
43
|
+
- **Smart protection**: Code fences and HTML comments are preserved unchanged by default (configurable)
|
|
46
44
|
|
|
47
45
|
## Installation
|
|
48
46
|
|
|
@@ -186,8 +184,8 @@ Anchors work for document links:
|
|
|
186
184
|
- `[text](/absolute/path.md)` - Absolute paths
|
|
187
185
|
- `[text](../relative/path.md)` - Explicit relative paths with directories
|
|
188
186
|
- `[text](#anchor)` - Fragment-only links
|
|
189
|
-
- Links/images inside code fences (` ``` ` or `~~~`)
|
|
190
|
-
- Links/images inside HTML comments (`<!-- -->`)
|
|
187
|
+
- Links/images inside code fences (` ``` ` or `~~~`) — unless `protect_code_fences: false`
|
|
188
|
+
- Links/images inside HTML comments (`<!-- -->`) — unless `protect_html_comments: false`
|
|
191
189
|
|
|
192
190
|
### Protected Content
|
|
193
191
|
|
|
@@ -205,7 +203,7 @@ The plugin intelligently ignores links in:
|
|
|
205
203
|
<!-- This [link](example.md) won't be processed -->
|
|
206
204
|
```
|
|
207
205
|
|
|
208
|
-
This ensures that example code and commented-out content remain unchanged.
|
|
206
|
+
This ensures that example code and commented-out content remain unchanged. Both behaviours are configurable via `protect_code_fences` and `protect_html_comments`.
|
|
209
207
|
|
|
210
208
|
**Important: Indented Content**
|
|
211
209
|
|
|
@@ -229,6 +227,7 @@ This design choice ensures the plugin works seamlessly with MkDocs features like
|
|
|
229
227
|
**Files that are excluded from mapping:**
|
|
230
228
|
- Files starting with `.` (dotfiles) - always ignored
|
|
231
229
|
- Files listed in `ignore_files` configuration - useful for drafts and templates
|
|
230
|
+
- Files in directories listed in `exclude_dirs`
|
|
232
231
|
|
|
233
232
|
## Using with mkdocs-macros-plugin (Snippets)
|
|
234
233
|
|
|
@@ -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,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mkdocs-easylinks-plugin
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.2.0
|
|
4
4
|
Summary: An MkDocs plugin that allows linking to files by filename only
|
|
5
5
|
Author: Daniel Ferguson
|
|
6
6
|
License: MIT
|
|
@@ -12,13 +12,11 @@ Classifier: Development Status :: 4 - Beta
|
|
|
12
12
|
Classifier: Intended Audience :: Developers
|
|
13
13
|
Classifier: License :: OSI Approved :: MIT License
|
|
14
14
|
Classifier: Programming Language :: Python :: 3
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
17
15
|
Classifier: Programming Language :: Python :: 3.10
|
|
18
16
|
Classifier: Programming Language :: Python :: 3.11
|
|
19
17
|
Classifier: Programming Language :: Python :: 3.12
|
|
20
18
|
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
-
Requires-Python: >=3.
|
|
19
|
+
Requires-Python: >=3.10
|
|
22
20
|
Description-Content-Type: text/markdown
|
|
23
21
|
License-File: LICENSE
|
|
24
22
|
Requires-Dist: mkdocs>=1.4.0
|
|
@@ -42,7 +40,7 @@ An MkDocs plugin that allows you to create cross-references and embed images by
|
|
|
42
40
|
- **Link statistics**: See which files are most linked and find orphaned content
|
|
43
41
|
- **Ambiguity warnings**: Get notified if multiple files share the same name
|
|
44
42
|
- **Material for MkDocs compatible**: Works seamlessly with Material theme
|
|
45
|
-
- **Smart protection**: Code fences and HTML comments are preserved unchanged
|
|
43
|
+
- **Smart protection**: Code fences and HTML comments are preserved unchanged by default (configurable)
|
|
46
44
|
|
|
47
45
|
## Installation
|
|
48
46
|
|
|
@@ -186,8 +184,8 @@ Anchors work for document links:
|
|
|
186
184
|
- `[text](/absolute/path.md)` - Absolute paths
|
|
187
185
|
- `[text](../relative/path.md)` - Explicit relative paths with directories
|
|
188
186
|
- `[text](#anchor)` - Fragment-only links
|
|
189
|
-
- Links/images inside code fences (` ``` ` or `~~~`)
|
|
190
|
-
- Links/images inside HTML comments (`<!-- -->`)
|
|
187
|
+
- Links/images inside code fences (` ``` ` or `~~~`) — unless `protect_code_fences: false`
|
|
188
|
+
- Links/images inside HTML comments (`<!-- -->`) — unless `protect_html_comments: false`
|
|
191
189
|
|
|
192
190
|
### Protected Content
|
|
193
191
|
|
|
@@ -205,7 +203,7 @@ The plugin intelligently ignores links in:
|
|
|
205
203
|
<!-- This [link](example.md) won't be processed -->
|
|
206
204
|
```
|
|
207
205
|
|
|
208
|
-
This ensures that example code and commented-out content remain unchanged.
|
|
206
|
+
This ensures that example code and commented-out content remain unchanged. Both behaviours are configurable via `protect_code_fences` and `protect_html_comments`.
|
|
209
207
|
|
|
210
208
|
**Important: Indented Content**
|
|
211
209
|
|
|
@@ -229,6 +227,7 @@ This design choice ensures the plugin works seamlessly with MkDocs features like
|
|
|
229
227
|
**Files that are excluded from mapping:**
|
|
230
228
|
- Files starting with `.` (dotfiles) - always ignored
|
|
231
229
|
- Files listed in `ignore_files` configuration - useful for drafts and templates
|
|
230
|
+
- Files in directories listed in `exclude_dirs`
|
|
232
231
|
|
|
233
232
|
## Using with mkdocs-macros-plugin (Snippets)
|
|
234
233
|
|
|
@@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "mkdocs-easylinks-plugin"
|
|
7
|
-
version = "0.
|
|
7
|
+
version = "0.2.0"
|
|
8
8
|
description = "An MkDocs plugin that allows linking to files by filename only"
|
|
9
9
|
readme = "README.md"
|
|
10
|
-
requires-python = ">=3.
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
11
|
license = {text = "MIT"}
|
|
12
12
|
authors = [
|
|
13
13
|
{name = "Daniel Ferguson"}
|
|
@@ -18,8 +18,6 @@ classifiers = [
|
|
|
18
18
|
"Intended Audience :: Developers",
|
|
19
19
|
"License :: OSI Approved :: MIT License",
|
|
20
20
|
"Programming Language :: Python :: 3",
|
|
21
|
-
"Programming Language :: Python :: 3.8",
|
|
22
|
-
"Programming Language :: Python :: 3.9",
|
|
23
21
|
"Programming Language :: Python :: 3.10",
|
|
24
22
|
"Programming Language :: Python :: 3.11",
|
|
25
23
|
"Programming Language :: Python :: 3.12",
|
{mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/.github/workflows/publish.yml
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mkdocs_easylinks_plugin-0.1.4 → mkdocs_easylinks_plugin-0.2.0}/mkdocs_easylinks/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|