Inconsistency between dialect of markdown in page and edit preview #690

Closed
colinmorris opened this Issue Apr 26, 2013 · 4 comments

Comments

Projects
None yet
4 participants
@colinmorris

To reproduce:

  • create a fresh repo
  • gollum
  • Type this is **emphatic** but this is (**not**)
  • Click save

New page body looks like:
this is emphatic but this is (not)

  • click edit

Preview shows:
this is emphatic but this is (not)

It seems like the page is rendered with Github Flavored Markdown (which doesn't allow intra-word emphasis), but the preview uses vanilla markdown (which does allow it). This seems like a bug to me, though it's not clear to me which dialect is supposed to be used for both, nor how to change between them.

Edit: While I'm here, I'd like to add that, from a usability standpoint, I find that having such vastly different editors for making a page vs. editing a page is confusing. The interface for creating a page is basically a textarea, whereas the editing interface tries to guess my intentions like MS Word (e.g. by inserting a new bullet point when I hit return in a list, or turning pairs of spaces into pseudo-tabs).

@mwolf-net

This comment has been minimized.

Show comment
Hide comment
@mwolf-net

mwolf-net Apr 28, 2014

I have the same issue, except it seems to be the other way around: the live preview supports GHFM extensions such as tables, strikethrough and the suppression of intra-word emphasis, but the actual page rendering does not seem to support these extensions.

It's not completely consistent, however; for example, MathJax and language-specific syntax highlighting appear to be supported in both modes.

Edit -- hmm this is weird actually; I have two machines here which are pretty much identical as far as the versions of Ruby, Gollum and the required gems are concerned, but one of them doesn't seem to support GHFM extensions in the non-preview renderer, while the other one does. If I can figure out what the difference is, I'll report back..

I have the same issue, except it seems to be the other way around: the live preview supports GHFM extensions such as tables, strikethrough and the suppression of intra-word emphasis, but the actual page rendering does not seem to support these extensions.

It's not completely consistent, however; for example, MathJax and language-specific syntax highlighting appear to be supported in both modes.

Edit -- hmm this is weird actually; I have two machines here which are pretty much identical as far as the versions of Ruby, Gollum and the required gems are concerned, but one of them doesn't seem to support GHFM extensions in the non-preview renderer, while the other one does. If I can figure out what the difference is, I'll report back..

@mwolf-net

This comment has been minimized.

Show comment
Hide comment
@mwolf-net

mwolf-net Apr 29, 2014

Never mind, in my case the problem was caused by the fact that the native portion of the github-markdown gem wasn't properly installed on one machine.

This issue is quite old; Gollum now (in v3.0.0) correctly uses GFM in both the preview and the final rendering. On the other hand, since the preview uses a separate Javascript-based Markdown engine, they will never be 100% identical. I think this issue can be closed.

Never mind, in my case the problem was caused by the fact that the native portion of the github-markdown gem wasn't properly installed on one machine.

This issue is quite old; Gollum now (in v3.0.0) correctly uses GFM in both the preview and the final rendering. On the other hand, since the preview uses a separate Javascript-based Markdown engine, they will never be 100% identical. I think this issue can be closed.

@dometto

This comment has been minimized.

Show comment
Hide comment
@dometto

dometto Nov 4, 2014

Member

I also wonder whether we should consider this a bug. Making sure the live preview editor exactly mirrors GFM seems like a lost cause. As long as the differences aren't too big (and the fact that two different markdown flavors are used is documented somewhere), can't we live with this?

Member

dometto commented Nov 4, 2014

I also wonder whether we should consider this a bug. Making sure the live preview editor exactly mirrors GFM seems like a lost cause. As long as the differences aren't too big (and the fact that two different markdown flavors are used is documented somewhere), can't we live with this?

@bartkamphorst

This comment has been minimized.

Show comment
Hide comment
@bartkamphorst

bartkamphorst Nov 4, 2014

Member

I say we can. 👍

Member

bartkamphorst commented Nov 4, 2014

I say we can. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment