Skip to content

Commit

Permalink
Minor docs improvements and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jacklinke committed Oct 22, 2024
1 parent 10961fc commit 61cd6c9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
19 changes: 11 additions & 8 deletions docs/terminology.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Terminology and Definitions

## Django Templated Email
Django Templated Email is a package that allows you to send emails using Django templates. It provides a convenient way to create and send HTML and plain text emails using Django's templating system, and it integrates nicely with anymail.

## Markdown
Markdown is a lightweight markup language with plain-text formatting syntax. It's designed to be easy to read and write, and can be converted to HTML and other formats.

## Premailer
Premailer is a tool used to inline CSS styles in HTML documents. In the context of email templates, it helps ensure that styles are applied consistently across different email clients.
[Django Templated Email](https://github.com/vintasoftware/django-templated-email/) is a package that allows you to send emails using Django templates. It provides a convenient way to create and send HTML and plain text emails using Django's templating system, and it integrates nicely with anymail. It is particularly useful for sending transactional emails.

## html2text
html2text is a Python library that converts HTML to plain text. In django-templated-email-md, it's used to generate the plain text version of emails from the rendered HTML.
[html2text](https://github.com/Alir3z4/html2text/) is a Python library that converts HTML to plain text. In django-templated-email-md, it's used to generate the plain text version of emails from the rendered HTML.

## Markdown
Markdown is a lightweight markup language with plain-text formatting syntax. It's designed to be easy to read and write, and can be converted to HTML and other formats. [Markdown](https://github.com/Python-Markdown/markdown) is also the name of a popular Python package that provides tools for working with Markdown text.

## Multipart Email
A multipart email is an email that contains multiple parts, typically an HTML version and a plain text version of the message. This allows email clients to display the most appropriate version based on their capabilities.

## Preheader
A preheader is a short summary or preview of an email message that appears in the inbox before the email is opened. It's typically displayed next to the subject line and can help entice recipients to open the email.

## Premailer
[Premailer](https://github.com/peterbe/premailer) is a tool used to inline CSS styles in HTML documents. In the context of email templates, it helps ensure that styles are applied consistently across different email clients.
3 changes: 2 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ You can use Django's template language within your Markdown templates to make ea

## Sending Emails

Use the `send_templated_mail` function from `django-templated-email` to send emails using your Markdown templates:
Use the [`send_templated_mail`](https://github.com/vintasoftware/django-templated-email/?tab=readme-ov-file#sending-templated-emails) function from `django-templated-email` to send emails using your Markdown templates:

```python
from templated_email import send_templated_mail
Expand Down Expand Up @@ -423,6 +423,7 @@ TEMPLATED_EMAIL_HTML2TEXT_SETTINGS = {
'mark_code': True,
'wrap_links': True,
}
```

### Error Handling

Expand Down

0 comments on commit 61cd6c9

Please sign in to comment.