Metadata-Version: 2.1
Name: embedmd
Version: 0.4.1
Summary: Embed markdown files into html
Home-page: https://github.com/kylepollina/embedmd
Author: Kyle Pollina
Author-email: kylepollina@pm.me
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: markdown


# embedmd

`embedmd` is a command line tool to embed Markdown 
documents within HTML. This tool utilizes the very powerful 
[Python-Markdown](https://python-markdown.github.io/) package.

## Installation

```
pip install embedmd
```

## Usage

Place this text in your HTML file where you want to embed markdown:

```html
<#INCLUDE filename.md>
```

Where `filename.md` is pointing to the markdown file you wish to embed
in that spot of the HTML file. Then, run the tool from the command line.

```shell
embedmd input.html
```

### Example

Say we have this HTML file...

```html
<!-- template.html -->

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
  </head>
  <body>
    <div id="container">

      <#INCLUDE test1.md>

      <#INCLUDE test2.md>

    </div>
  </body>
</html>
```

... and we want to embed these markdown documents within.

```markdown
# test1.md

Hello world, this is brought to you using [embedmd](https://github.com/kylepollina/embedmd)
```

```markdown
# test2.md

| date       | species
| :-----     | :-------
| 2020-07-21 | Red-winged blackbird
| 2020-07-21 | Eurasian Tree sparrow
```

Running the `embedmd` command:

```
embedmd template.html
```

will print out

```html
<!-- template.html -->

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
  </head>
  <body>
    <div id="container">

      <h1>test1.md</h1>
<p>Hello world, this is brought to you using <a href="https://github.com/kylepollina/embedmd">embedmd</a></p>

      <h1>test2.md</h1>
<table>
<thead>
<tr>
<th align="left">date</th>
<th align="left">species</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">2020-07-21</td>
<td align="left">Red-winged blackbird</td>
</tr>
<tr>
<td align="left">2020-07-21</td>
<td align="left">Eurasian Tree sparrow</td>
</tr>
</tbody>
</table>

    </div>
  </body>
</html>
```

-------
![example output](images/img1.png)
-------


### Parameters

`embedmd` also supports sending simple parameters from the HTML file to the
markdown file. Using parameters follows this pattern:

```html
<!-- params.html -->
<#INCLUDE filename.md : param1=value1, param2=value2>
```

And `filename.md` can capture these parameters by encapsulating 
the parameters with double curly braces.

```markdown
# filename.md

{{param1}}

{{ param2 }}
```

Running `embedmd params.html` will print:

```html
<!-- params.html -->

<h1>filename.md</h1>
<p>value1</p>
<p>value2</p>
```

-------

### License

MIT License
Copyright Kyle Pollina

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.


