Skip to content

Converts a markdown file to the HTML for sending as a newletter.

License

Notifications You must be signed in to change notification settings

HackSocNotts/markdown-newsletter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HackSoc Markdown Newsletter Converter

Converts a markdown file to the HTML for sending as a newsletter using an existing template.

REQUIREMENTS

  • A recent version of Python 3 (Only tested on Python 3.8+)
  • Marko pip3 install marko
  • Premailer pip3 install premailer

USAGE

python3 newsletter.py [template file] [markdown file]

The template file should be a HTML file with all of the styling and such included. Put the string <!--REPLACED_WITH_CONTENT--> into the body where you want the content to go and it will be replaced with the content from the markdown.

Otherwise the markdown is standard CommonMark.

TODO

  • Look into better (more markdown like) way to add buttons.
  • Add Docs into program help output.
  • Add [-v|--verbose] flag to print HTML while program is running.
  • Check HTML output for accessibility.
  • Check HTML output for compatibility. (I'm looking at you, Outlook)

About

Converts a markdown file to the HTML for sending as a newletter.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published