markbind icon indicating copy to clipboard operation
markbind copied to clipboard

Support an easy syntax for pull quotes

Open damithc opened this issue 2 years ago • 9 comments

Suggestion: perhaps an easy way to add something like this (I think they are called pull quotes)?

image

damithc avatar Feb 10 '23 08:02 damithc

Hi @damithc do you just mean a block quote? A pull quote has to be pulled directly from the internal text while a blockquote allows both internal and external quotation.

yucheng11122017 avatar Feb 10 '23 09:02 yucheng11122017

To add on to what @yucheng11122017 has pointed out, looks like there may be some ambiguity because our pre-existing blockquote component is known as a blockquote in markdown as can be seen here, but HTML also has an in-built blockquote element that is exactly as described above by @damithc as can be seen here (the demo shown in the link has CSS applied to it causing the grey background), and is declared the same way as our blockquote tag but produces different results.

lhw-1 avatar Feb 10 '23 10:02 lhw-1

I meant pull quote -- the one that is meant to grab attention (e.g., larger font size). I think we have support for block quote already. That said, my focus was on how it is displayed in an attention grabbing way, rather than whether it is 'pulled' from the regular text.

damithc avatar Feb 10 '23 10:02 damithc

In that case, maybe we should just allow blockcode tag to use a non markdown format like what @damithc showed in the photo? So it can have two types based on arguements (same as markdown and same as the photo)

yucheng11122017 avatar Feb 10 '23 11:02 yucheng11122017

In that case, maybe we should just allow blockcode tag to use a non markdown format like what @damithc showed in the photo? So it can have two types based on arguements (same as markdown and same as the photo)

Are you referring to styling <blockquote> differently, as compared to > ?

If the pull quote idea is to have

the one that is meant to grab attention (e.g., larger font size)

regardless of whether it is a quotation or not (which in the example given, not necessarily the case), then let's not mix the two which might make the syntax confusing.

but HTML also has an in-built blockquote element that is exactly as described above by @damithc as can be seen here (the demo shown in the link has CSS applied to it causing the grey background), and is declared the same way as our blockquote tag but produces different results.

Not exactly. The example shows how they make blockquote elements more prominent, but the content is still about quotation, just differences in CSS. As mentioned in the MDN article and in the HTML spec, blockquote is meant for quoting, so I won't say there's any ambiguity in markdown vs html.


We can look for a new syntax/component design if needed.

By the way, @damithc does the combination of ++ (large) and -> (center align) work for your use case? Looks like this:

++->Remember, NEVER rewrite the commit history<-++

Output: image

tlylt avatar Feb 10 '23 15:02 tlylt

By the way, @damithc does the combination of ++ (large) and -> (center align) work for your use case? Looks like this:

++->Remember, NEVER rewrite the commit history<-++

I think a custom component (or a new box style) might be better? e.g., then we can add things like the ability to inline with text like this: image

Still, I'm not fully convinced it is worth adding a component like this, or adding this feature at all. It's something we can explore nevertheless. Certainly not a high priority.

damithc avatar Feb 10 '23 16:02 damithc

I think a custom component (or a new box style) might be better? e.g., then we can add things like the ability to inline with text like this: image

Still, I'm not fully convinced it is worth adding a component like this, or adding this feature at all. It's something we can explore nevertheless. Certainly not a high priority.

Sure, I think we need to settle on the style we want and for what purpose to move this forward. Depending on whether this is mainly for quotations or a generic callout of a section of text, we can do things like adding an inline option for the existing box component instead of creating a new one.

tlylt avatar Feb 11 '23 01:02 tlylt

I feel that a pull quotes component would be too similar to our current Box component - it doesn't offer much additional functionality beyond a different styling option which could also be achieved with Box's styling options. Maybe it would be suitable as a plugin for additional styled components?

I think a custom component (or a new box style) might be better? e.g., then we can add things like the ability to inline with text like this: image

adding an inline option for the existing box component instead of creating a new one.

I think having component inline with text is worth exploring! It makes the site look less markdown-y.

jovyntls avatar Feb 12 '23 03:02 jovyntls

I second Jovyn's comments on pull quotes - I think in terms of just emphasizing particular text the box component, large + center align, or CSS styling can mostly handle the use case. But creating a component that would be displayed inline with text would be really cool - it could also be extended to images.

kaixin-hc avatar Mar 13 '24 09:03 kaixin-hc