mkdocs-simple-plugin

v3.2.0

Plugin for adding simple wiki site creation from markdown files interspersed within your code with MkDocs. For more information about how to use this package see README

Latest version published 5 months ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

67 / 100

security
Security review needed
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Popularity

Recognized

GitHub Stars: 42
Forks: 10
Contributors: 8

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Jul 14, 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

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like mkdocs-simple-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: 1
Open PR: 2
Last Release: 5 months ago
Last Commit: 1 month ago

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

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

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 8
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-simple-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

Age: 5 years
Latest Release: 5 months ago
Dependencies: 0 Direct
Versions: 40
Maintainers: 0
Wheels: OS Independent

Readme

mkdocs-simple-plugin

This plugin enables you to build a documentation site from markdown interspersed within your repository using mkdocs.

About

You may be wondering why you would want to generate a static site for your project without doing the typical "wiki" thing of consolidating all documentation within a single docs folder or using a single README file.

My repository is too big for a single documentation source.

Sometimes it isn't feasible to consolidate all documentation within an upper level docs directory. In general, if your codebase is too large to fit well within a single include directory, your codebase is also too large for documentation in a single docs directory.

Since it's typically easier to keep documentation up to date when it lives as close to the code as possible, it is better to create multiple sources for documentation.
My repository is too simple for advanced documentation.

If your codebase is very very large, something like the monorepo plugin might better fit your needs.

For most other medium+ repositories that have grown over time, you probably have scattered documentation throughout your code. By combining all of that documentation while keeping folder structure, you can better surface and collaborate with others. And, let's face it. That documentation is probably all in markdown since Github renders it nicely.
I want a pretty documentation site without the hassle.

Finally, you may be interested in this plugin if you have a desire for easy-to-generate stylized documentation. This plugin lets you take documentation you may already have -- either in markdown files or in your code -- and formats them into a searchable documentation website. You can keep your documentation where it is (thank you very much).

See mkdocs-simple-plugin for usage.

Contributing

See the contributing guide

License

This software is licensed under Apache 2.0

FAQs

What is mkdocs-simple-plugin?

Plugin for adding simple wiki site creation from markdown files interspersed within your code with MkDocs. Visit Snyk Advisor to see a full health score report for mkdocs-simple-plugin, including popularity, security, maintenance & community analysis.

Is mkdocs-simple-plugin popular?

The python package mkdocs-simple-plugin receives a total of 10,474 weekly downloads. As such, mkdocs-simple-plugin popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is mkdocs-simple-plugin well maintained?

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

Is mkdocs-simple-plugin safe to use?

While scanning the latest version of mkdocs-simple-plugin, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 22 December-2024, at 16:21 (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-simple-plugin

About

Contributing

License

FAQs

What is mkdocs-simple-plugin?

Is mkdocs-simple-plugin popular?

Is mkdocs-simple-plugin well maintained?

Is mkdocs-simple-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