mkdocs-markdownextradata-plugin | MkDocs plugin that injects the mkdocs.yml extra variables | Plugin library

by rosscdh Python Version: 0.2.5 License: MIT

X-Ray Key Features Code Snippets(3)Community Discussions(1)Vulnerabilities Install Support

kandi X-RAY | mkdocs-markdownextradata-plugin Summary

mkdocs-markdownextradata-plugin is a Python library typically used in Plugin applications. mkdocs-markdownextradata-plugin has no bugs, it has no vulnerabilities, it has build file available, it has a Permissive License and it has low support. You can install using 'pip install mkdocs-markdownextradata-plugin' or download it from GitHub, PyPI.

A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template

Support

Quality

Security

License

Reuse

Support

mkdocs-markdownextradata-plugin has a low active ecosystem.

It has 58 star(s) with 17 fork(s). There are 3 watchers for this library.

It had no major release in the last 12 months.

There are 6 open issues and 25 have been closed. On average issues are closed in 16 days. There are 1 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of mkdocs-markdownextradata-plugin is 0.2.5

Quality

mkdocs-markdownextradata-plugin has 0 bugs and 0 code smells.

Security

mkdocs-markdownextradata-plugin has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

mkdocs-markdownextradata-plugin code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

mkdocs-markdownextradata-plugin is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

mkdocs-markdownextradata-plugin releases are available to install and integrate.

Deployable package is available in PyPI.

Build file is available. You can build the component from source.

Installation instructions, examples and code snippets are available.

mkdocs-markdownextradata-plugin saves you 62 person hours of effort in developing the same functionality from scratch.

It has 173 lines of code, 9 functions and 4 files.

It has medium code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed mkdocs-markdownextradata-plugin and discovered the below as its top functions. This is intended to give you an instant insight into mkdocs-markdownextradata-plugin implemented functionality, and help decide if they suit your requirements.

Initialize build files
Add data to the config
Applies the title to the given page
Render a template string
Read file content

Get all kandi verified functions for this library.

mkdocs-markdownextradata-plugin Key Features

No Key Features are available at this moment for mkdocs-markdownextradata-plugin.

mkdocs-markdownextradata-plugin Examples and Code Snippets

mkdocs-markdownextradata-plugin,Features,Use Extra Variables in your markdown files

Python

Lines of Code : 13

License : Permissive (MIT)

Copy

site_name: My fantastic site

plugins:
    - search
    - markdownextradata

extra:
  customer:
    name: Your name here
    web: www.example.com
    salt: salt.example.com

{{ customer.name }}
{{ customer.web }}

mkdocs-markdownextradata-plugin,Features,Using external data files

Python

Lines of Code : 11

License : Permissive (MIT)

Copy

plugins:
    - search
    - markdownextradata:
        data: path/to/datafiles

plugins:
    - search
    - markdownextradata:
        data: path/to/datafiles, another/path/to/datafiles

plugins:
    - search
    - markdownextradata

mkdocs-markdownextradata-plugin,Installation

Python

Lines of Code : 4

License : Permissive (MIT)

Copy

pip install mkdocs-markdownextradata-plugin

plugins:
    - search
    - markdownextradata: {}

Community Discussions

Trending Discussions on mkdocs-markdownextradata-plugin

mkdocs: Using a custom python module to complement a plugin

QUESTION

mkdocs: Using a custom python module to complement a plugin

Asked 2018-Jul-02 at 15:26

I would like to write a plugin for mkdocs that allows to add a file of custom python code. Here is an example of plugin.

I would like to put the module in the website's main dir, alongside the mkdocs.yml file, and declare that module in there, e.g.:

...

ANSWER

Answered 2018-Jun-25 at 17:40

The answer depends on which version of MkDocs you are using. In #1376 the path was added to the config object as the attribute config.config_file_path. However, that won't be available until the next release (1.0). Regardless, earlier versions include an undocumented config option config['config_file_path'] which holds the location of the file. Be careful however, as any undocumented features are subject to change without notice.

As for the location of the Markdown file, that is available in various attributes of the page object passed to the plugin event. You have your pick of page.input_path, page.output_path, page.abs_input_path, and page.abs_output_path. Again, these are undocumented and subject to change in a future release without notice. In fact, #1504 proposes changing them to page.file.src_path, page.file.dest_path, page.file.abs_src_path, and page.file.abs_dest_path for the 1.0 release. But that's the risk in working against pre-1.0 software. Things change as the developers try to get it right. The good news is that the 1.0 release will lock these things down going forward.

Full disclosure: I am a member of the MkDocs development team.

Source https://stackoverflow.com/questions/51012689

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install mkdocs-markdownextradata-plugin

Note: This package requires MkDocs version 0.17 or higher.

Support

From reporting a bug to submitting a pull request: every contribution is appreciated and welcome. Report bugs, ask questions and request features using Github issues. If you want to contribute to the code of this project, please read the Contribution Guidelines.

Find more information at: