Metadata-Version: 2.1
Name: mdx-link2md
Version: 0.0.1
Summary: A markdown link preprocessor for Python Markdown
Home-page: https://github.com/scyu16/mdx_link2md
Author: scyu16
Author-email: devmaily@yandex.com
License: MIT
Keywords: markdown,html
Platform: UNKNOWN
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
Requires-Dist: markdown (>=2.6.11)

# Mdx Link2MD: Convert markdown to HTML in batch

This extension for [Python Markdown](https://github.com/waylan/Python-Markdown)
changes `md` extension in the markdown links to `html` before links in the text 
are converted to HTML hyperlinks. For example, the sample text in markdown format,

```markdown
Please read [help](../read.md)
```

would be converted to
```html
Please read <a href="../read.html">help</a>
```
.

This would allow converting markdown files to HTML format in batch,
with internal links to markdown files being updated to the corresponding HTML files. It
helps most when there are cross references among the markdown documents of 
interest.

## Usage

### Minimal Example

```python
from markdown import markdown
from mdx_link2md.markdownlinks import MarkdownLinkExtension


md = markdown.Markdown(output_format='html5',
                       extensions=[MarkdownLinkExtension(ignore_url=False)])
md.convertFile('input_file', output='output_file', encoding='utf-8')

```
Please see [markdown2html.py](./examples/markdown2html.py) for a working example, which
could also be used as a utility to convert markdown files in batch. 

### Configuration Settings

The only setting for the extension is `ignore_url`, with a `True` default value.
When `ignore_url` is `False`, markdown links to none local files are also updated:

|ignore_url| input | output |
|:--------:| :-----: | :-------:|
|True      | ```[help](http://xyz.com/read.mD)```|```<a href="http://xyz.com/read.mD">help</a>```|
|False      | ```[help](http://xyz.com/read.mD)```|```<a href="http://xyz.com/read.html">help</a>```|

*Note*: the preprocessing is case insensitive to the `md` file extension.

## Installation


## Development

## Releasing


