#198 - Markdown specification (part 1 of 2) #209
Conversation
MackHalliday
changed the title
tests/test_files/html/images.html
Outdated
| <h2>Inline images</h2> | ||
| <h2>Reference images</h2> | ||
| <p>The reference is immediately after the image.</p> | ||
| <p>The reference is not immediately after the iamge.</p> |
tests/test_files/markdown/images.md
Outdated
| text before ![alt text][image4] text after | ||
| [image4]: https://www.example.com/test.png "title text" | ||
|
|
||
| The reference is not immediately after the iamge. |
|
|
||
| The reference is immediately after the image. | ||
|
|
||
| The reference is not immediately after the iamge. |
tests/test_files/html/lists.html
Outdated
| <li>item F</li> | ||
| </ul> | ||
| </li> | ||
| <li>item 3<ul> |
| @@ -0,0 +1,4 @@ | |||
| <p>Colons can be used to align columns.</p> | |||
There was a problem hiding this comment.
Do you want text in here indicating that tables will be stripped from html?
There was a problem hiding this comment.
Not here. I documented that in the index file. The input markdown reflected here is copied directly from here.
There was a problem hiding this comment.
I just mean to write some text in here like you did for the images.html that says the table is going to be stripped. I found it confusing to read the text that is here and to not see any tables, but I will defer to your judgement.
| @@ -0,0 +1,5 @@ | |||
| Colons can be used to align columns. | |||
There was a problem hiding this comment.
do you want text in here indicating that tables will be stripped from plain text?
There was a problem hiding this comment.
Not here. I documented that in the index file. The input markdown reflected here is copied directly from here.
| 6. item 3 | ||
| 6. item 4 |
There was a problem hiding this comment.
did you mean for these to both be 6? they aren't in the html above?
There was a problem hiding this comment.
That's intentional. Markdown just requires digits to denote an ordered list. They don't need to be unique or in order.
There was a problem hiding this comment.
Can you note that somewhere so that someone doesn't come along later and 'fix' it?
tests/test_files/index.md
Outdated
|
|
||
| ## Unsupported markdown | ||
|
|
||
| VA Notify markdown is not gauranteed to support: |
tests/test_files/index.md
Outdated
|
|
||
| ## Supported markdown | ||
|
|
||
| VA Notify markdown support mostly aligns with [Github markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). Some addtionally supported markdown includes: |
kalbfled
requested review from
ChrisJohnson-CDJ,
cris-oddball and
MackHalliday
Description
These changes add test markdown templates that should serve as a comprehensive specification for how the Notify app should convert markdown entered into Portal into HTML or plain text.
The expected HTML intentionally does not include any inline styling, which departs from the current implementation. The intent is that a future implementation will apply all CSS through Jinja templates rather than using custom Mistune to add inline styles.
These changes do not include any markdown templates with placeholders. They will be added as necessary for #199.
These changes do not include any unit tests or implementation.
issue #198
How Has This Been Tested?
Checklist