Skip to content

Commit

Permalink
[DOC]
Browse files Browse the repository at this point in the history
  • Loading branch information
Maxime Brazeilles committed Apr 5, 2023
1 parent c8fc1c5 commit 46f3c40
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ A clear and concise description of what you expected to happen.

**MJML environment (please complete the following information):**
- OS: [e.g. MacOS]
- MJML Version [e.g. 4.2.0]
- MJML Version [e.g. 5.x.x]
- MJML tool used [e.g MJML App]

**Email sending environment(for rendering issues)**:
- Platform used to send the email [e.g [Putsmail](https://putsmail.com/)]
- Platform used to send the email [e.g [Putsmail](https://putsmail.com/)]

**Affected email clients (for rendering issues):**
- Email Client [e.g Gmail]
- Email Client [e.g Gmail]
- OS: [e.g. Windows]
- Browser [e.g. Google Chrome]

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MJML 4
# MJML 5

If you're looking for MJML 3.3.X check [this branch](https://github.com/mjmlio/mjml/tree/3.3.x)
If you're looking for MJML 4.14.X check [this branch](https://github.com/mjmlio/mjml/tree/4.14.x)

<p style="text-align: center;" >
<a href="https://mjml.io" target="_blank">
Expand Down Expand Up @@ -96,12 +97,11 @@ You can pass optional `arguments` to the CLI and combine them.

argument | description | default value
---------|--------|--------------
`mjml -m [input]` | Migrates a v3 MJML file to the v4 syntax | NA
`mjml [input] -o [output]` | Writes the output to [output] | NA
`mjml [input] -s` | Writes the output to `stdout` | NA
`mjml -w [input]` | Watches the changes made to `[input]` (file or folder) | NA
`mjml [input] --config.beautify` | Beautifies the output (`true` or `false`) | true
`mjml [input] --config.minify` | Minifies the output (`true` or `false`) | false
`mjml [input] --config.beautify` | Beautifies the output (`true` or `false`) requires js-beautify in package.json | true
`mjml [input] --config.minify` | Minifies the output (`true` or `false`) requires html-minifier in package.json | false

See [mjml-cli documentation](https://github.com/mjmlio/mjml/blob/master/packages/mjml-cli/README.md) for more information about config options.

Expand Down
4 changes: 2 additions & 2 deletions packages/mjml/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MJML 4
# MJML 5

<p style="text-align: center;" >
<a href="http://mjml.io" target="_blank">
Expand Down Expand Up @@ -133,7 +133,7 @@ minifyOptions | Options for html minifier, see [mjml-cli documentation](https://
mjmlConfigPath | string | The path or directory of the `.mjmlconfig` file (for custom components use) | `process.cwd()`
useMjmlConfigOptions | Allows to use the `options` attribute from `.mjmlconfig` file | false

Note that it's also possible to define preprocessors in your mjmlconfig file. For this, you need to use a `.mjmlconfig.js` file. This js file needs to export an Object with the same structure as a standard JSON .mjmlconfig file.
Note that it's also possible to define preprocessors in your mjmlconfig file. For this, you need to use a `.mjmlconfig.js` file. This js file needs to export an Object with the same structure as a standard JSON .mjmlconfig file.

## API

Expand Down
3 changes: 2 additions & 1 deletion readme-ja.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MJML 4
# MJML 5

もしも、MJML 3.3.Xについて探しているのであれば、[このブランチ](https://github.com/mjmlio/mjml/tree/3.3.x)をご確認ください。
もしも、MJML 4.14.Xについて探しているのであれば、[このブランチ](https://github.com/mjmlio/mjml/tree/4.14.x)をご確認ください。

<p style="text-align: center;" >
<a href="https://mjml.io" target="_blank">
Expand Down

0 comments on commit 46f3c40

Please sign in to comment.