Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improve mj-text doc #2492

Merged
merged 3 commits into from Aug 25, 2022
Merged

improve mj-text doc #2492

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78babe8
improve mj-text doc
mifi Jun 30, 2022
c8db7f1
Update README.md
mifi Jul 16, 2022
8967597
Update README.md
mifi Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 7 additions & 6 deletions packages/mjml-text/README.md
View file
Open in desktop
@@ -1,16 +1,17 @@
## mj-text

This tag allows you to display text in your email.
This tag allows you to display text and HTML in your email and has shorthand attributes for easily styling its children.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and has shorthand attributes for easily styling its children

Not sure this provide any value here. But 👍 to add HTML mentioned

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what is the purpose of font-family="Helvetica" color="#F45E43" etc other than being shorthands

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is self-explanatory, as you can say this for any component


```xml
<mjml>
<mj-body>
<mj-section>
<mj-column>
<mj-text>
<h1>
Hey Title!
</h1>
<mj-text font-family="Helvetica" color="#F45E43">
<h1>Title</h1>

<p>Paragraph</p>
<p style="font-family:Comic Sans Ms">Another paragraph</p>
</mj-text>
</mj-column>
</mj-section>
Expand All @@ -19,7 +20,7 @@ This tag allows you to display text in your email.
```

<p style="text-align: center;" >
<a href="https://mjml.io/try-it-live/components/text">
<a href="https://mjml.io/try-it-live/E7Tk_8zjI">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to change the link here it will fetch the content automatically 👍

<img width="100px" src="https://mjml.io/assets/img/svg/TRYITLIVE.svg" alt="try it live" />
</a>
</p>
Expand Down