Skip to content

Commit 87a825a

Browse files
committed
Fix typos
1 parent bf0861f commit 87a825a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

code/md_to_email/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,17 @@ template.html which contain the HTML structure that should render
1414
as a responsive email.
1515

1616
### Prerequisites
17-
This script requires python >= 3.5 and the following dependencise:
17+
This script requires python >= 3.5 and the following dependencies:
1818

1919
* [python-markdown2](https://github.com/trentm/python-markdown2)
2020
* [jinja](https://jinja.palletsprojects.com/en/2.10.x/)
2121
* [premailer](https://github.com/peterbe/premailer)
2222
* [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/bs4/doc/)
2323

24+
Install them using pip or conda before running the script.
25+
2426
## Using the script
25-
The script is run from the command line.
27+
This is a standalone script that should be from the command line.
2628

2729
To see the help:
2830
```
@@ -48,8 +50,15 @@ Using the sample template file on the provided file:
4850
python email_gen.py sample_doc.md
4951
```
5052

51-
Will generate a inlined HTML file titled sample_doc_email.html that can be copied
53+
Will generate an inlined HTML file titled sample_doc_email.html that can be copied
5254
into an HTML email.
5355

56+
## Customizing
57+
This simple script assumes that the markdown input file has header meta data
58+
that would be suitable for generating an article with [pelican](https://docs.getpelican.com/en/stable/).
59+
60+
You will likely need to customize the template and the email_gen.py file
61+
for your own needs.
62+
5463
## License
5564
This software is released under the BSD 3-Clause License.

0 commit comments

Comments
 (0)