ckeditor / github-writer

GitHub Writer - WYSIWYG Rich-Text Editor for GitHub, powered by CKEditor.
https://ckeditor.com/
Other
378 stars 62 forks source link

Unexpected changes in complex source Markdown file #254

Open paulhibbitts opened 3 years ago

paulhibbitts commented 3 years ago

The most recent release of CKEditor 5 for GitHub is amazing!

I hope to use this extension for editors of Markdown files for use with the Grav CMS (getgrav.org). I've discovered though for some complex MD files containing frontmatter and shortcodes there are some unexpected changes upon save.

Here is an example MD file:


---

title: 'Week 2 (May 16 - 22)'
published: true
date: '16-05-2018 00:00'
hide_from_post_list: false
hide_git_sync_repo_link: true
header_image_credit: 'CannedTuna, Flickr.com'
header_image_creditlink: 'https://www.flickr.com/photos/cannedtuna/4853380320/'
header_image_alt_text: 'Information architecture'

---

## What does a holistic user experience design process look like?

[Software Development Processes](https://www.google.ca/slides/about/)  
[User Experience Design Processes](https://www.google.ca/slides/about/)  
[Our Design Process (aka Toolkit)](https://www.google.ca/slides/about/)

===

## **What does a holistic user experience design process look like?**

### Summaries and Questions

[May 16th Class One-minute Summaries](https://canvas.sfu.ca/courses/55288/assignments)

### Presented Slides

[Placeholder Slides](https://docs.google.com/presentation/d/e/2PACX-1vSPiOUzmRG4EB6ng8KQgOwZEbVuN2u1d5tGVTiAyzlVuO_o4Zjyli3oAf_U_CqXml_6GMUBR9nUyEYb/pub?start=false&loop=false&delayms=3000)

[googleslides]https://docs.google.com/presentation/d/e/2PACX-1vSPiOUzmRG4EB6ng8KQgOwZEbVuN2u1d5tGVTiAyzlVuO_o4Zjyli3oAf_U_CqXml_6GMUBR9nUyEYb/embed?start=false&loop=false&delayms=3000[/googleslides]

### CPT-363 UX Design Process/Toolkit

![](https://test.hibbittsdesign.org/grav-skeleton-open-matter-course-hub-site/home/module-02/ux-design-process-v4.png)

### Handouts

[Product Reaction Cards](https://canvas.sfu.ca/courses/55288/files)

### Assignments

[Course Reflection Log](https://canvas.sfu.ca/courses/55288/assignments)

### Recommended Reading

[embedly]https://uxplanet.org/the-evolution-of-ux-process-methodology-47f52557178b[/embedly]

And here is the same file, with no changed saved using CKEditor 5:

---

title: 'Week 2 (May 16 - 22)'  
published: true  
date: '16-05-2018 00:00'  
hide\_from\_post\_list: false  
hide\_git\_sync\_repo\_link: true  
header\_image\_credit: 'CannedTuna, Flickr.com'  
header\_image\_creditlink: 'https://www.flickr.com/photos/cannedtuna/4853380320/'  
header\_image\_alt\_text: 'Information architecture'

---

## What does a holistic user experience design process look like?

[Software Development Processes](https://www.google.ca/slides/about/)  
[User Experience Design Processes](https://www.google.ca/slides/about/)  
[Our Design Process (aka Toolkit)](https://www.google.ca/slides/about/)

\===

## **What does a holistic user experience design process look like?**

### Summaries and Questions

[May 16th Class One-minute Summaries](https://canvas.sfu.ca/courses/55288/assignments)

### Presented Slides

[Placeholder Slides](https://docs.google.com/presentation/d/e/2PACX-1vSPiOUzmRG4EB6ng8KQgOwZEbVuN2u1d5tGVTiAyzlVuO_o4Zjyli3oAf_U_CqXml_6GMUBR9nUyEYb/pub?start=false&loop=false&delayms=3000)

\[googleslides\]https://docs.google.com/presentation/d/e/2PACX-1vSPiOUzmRG4EB6ng8KQgOwZEbVuN2u1d5tGVTiAyzlVuO_o4Zjyli3oAf_U_CqXml_6GMUBR9nUyEYb/embed?start=false&loop=false&delayms=3000[/googleslides]

### CPT-363 UX Design Process/Toolkit

![](https://test.hibbittsdesign.org/grav-skeleton-open-matter-course-hub-site/home/module-02/ux-design-process-v4.png)

### Handouts

[Product Reaction Cards](https://canvas.sfu.ca/courses/55288/files)

### Assignments

[Course Reflection Log](https://canvas.sfu.ca/courses/55288/assignments)

### Recommended Reading

\[embedly\]https://uxplanet.org/the-evolution-of-ux-process-methodology-47f52557178b[/embedly]

From what I can tell, some extra \ characters get added, which then makes the file not display properly in Grav. Here are the affected lines in the saved file, both in the frontmatter and main body:

hide\_from\_post\_list: false hide\_git\_sync\_repo\_link: true header\_image\_credit: 'CannedTuna, Flickr.com' header\_image\_creditlink: 'https://www.flickr.com/photos/cannedtuna/4853380320/' header\_image\_alt\_text: 'Information architecture'

\=== \[googleslides\\\]https://docs.google.com/presentation/d/e/2PACX-1vSPiOUzmRG4EB6ng8KQgOwZEbVuN2u1d5tGVTiAyzlVuO_o4Zjyli3oAf_U_CqXml_6GMUBR9nUyEYb/embed?start=false&loop=false&delayms=3000[/googleslides]
\[embedly\]https://uxplanet.org/the-evolution-of-ux-process-methodology-47f52557178b[/embedly]  

Thanks very much for looking at this issue, again amazing work with the CKEditor 5 for GitHub!
Paul