mkdocs-argref-plugin

v0.5.0

MkDocs plugin to replace argumented refrences with markdown links. For more information about how to use this package see README

Latest version published 3 months ago

License: MIT License Copyright for po…

PyPI

GitHub

Package Health Score

58 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Limited

Popularity

Limited

GitHub Stars: 1
Forks: 1
Contributors: 5

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package mkdocs-argref-plugin, we found that it has been starred 1 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Aug 25, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT License Copyright for portions of project mkdocs-argref-plugin are held by [Saurabh Kumar, 2020] as part of project Autolink References. All other copyright for project mkdocs-argref-plugin are held by [Richard Shadrach, 2024]. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Security Policy

We found a way for you to contribute to the project! Looks like mkdocs-argref-plugin is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 3 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of mkdocs-argref-plugin based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that mkdocs-argref-plugin demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 5
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like mkdocs-argref-plugin is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 6 months
Latest Release: 3 months ago
Dependencies: 1 Direct
Versions: 3
Maintainers: 1
Wheels: OS Independent

Readme

mkdocs-argref-plugin

This mkdocs plugin allows users to convert text such as GHI-123 in their documentation to a corresponding URL, e.g. https://github.com/myproject/issues/123. Unlike similar plugins, argref takes an argument for each reference that can be utilized in the URL.

Getting started

To install it, using pip:

pip install mkdocs-argref-plugin

Edit your mkdocs.yml file and add these few lines of code:

plugins:
   - argref:
        filter_links: False  #default
        autolinks:
            - reference_prefix: GH-
              target_url: https://github.com/myname/myproject/issues/
            - reference_prefix: JIRA--
              target_url: https://jiracloud.com/myproject-?ver=

filter_links: When True, will not make replacements within existing markdown links. Caution: This may impact performance in large environments. Defaults to False.
reference_prefix: This prefix appended by a number will generate a link any time it is found in a page. When no variable is present, will append `` as the variable.
target_url: The URL must contain all variables from reference_prefix.

An example

For example, you could edit the docs/index.md file and insert the ticket references like this:


Changelog:

- GHI-100: Add new feature.
- JIRA-231-XYZ: Fix bug.

This will be converted to:

Changelog:

- [GHI-100](https://github.com/myname/myproject/issues/100): Add new feature.
- [JIRA-231-XYZ](https://jiracloud.com/myproject-231?ver=XYZ): Fix bug.

Changelog

0.5.0 (2024-08-25)

Fix bug when filter_links=True and multiple autolinks are specified.

0.4.0 (2024-08-13)

Added ability to use multiple references for each link and skip replacements within links.

0.3.0 (2024-06-07)

Fixed bug where only one replacement would be made per page.

0.2.2 (2023-12-28)

Allow extended set for and ignore ref style links, already linked items, and attr_list cases with '#' before the ref

0.2.0

Ignore already linked references.
Converts text [AF-100] to a linked version and removes the brackets AF-100

License

MIT

Originally built with ❤️ by Saurabh Kumar

mkdocs-argref-plugin dependencies

mkdocs

FAQs

What is mkdocs-argref-plugin?

MkDocs plugin to replace argumented refrences with markdown links. Visit Snyk Advisor to see a full health score report for mkdocs-argref-plugin, including popularity, security, maintenance & community analysis.

Is mkdocs-argref-plugin popular?

We’re still processing downloads data for the python package mkdocs-argref-plugin. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is mkdocs-argref-plugin well maintained?

We found indications that mkdocs-argref-plugin maintenance is sustainable demonstrating some project activity. We saw a total of 5 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is mkdocs-argref-plugin safe to use?

The python package mkdocs-argref-plugin was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 24 November-2024, at 00:56 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

mkdocs-argref-plugin

Getting started

An example

Changelog

0.5.0 (2024-08-25)

0.4.0 (2024-08-13)

0.3.0 (2024-06-07)

0.2.2 (2023-12-28)

0.2.0

License

mkdocs-argref-plugin dependencies

FAQs

What is mkdocs-argref-plugin?

Is mkdocs-argref-plugin popular?

Is mkdocs-argref-plugin well maintained?

Is mkdocs-argref-plugin safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues