content icon indicating copy to clipboard operation
content copied to clipboard

missing document for ProsePre

Open xarthurx opened this issue 2 years ago • 3 comments

Is your feature request related to a problem? Please describe

When trying to check the styles of code highlight, I saw a ProsePre.vue for the highlight section. However, I cannot find any documentation on the website for this. image

Describe the solution you'd like

Add documentation of ProsePre for the Prose Component: https://content.nuxtjs.org/api/components/prose

xarthurx avatar Aug 31 '23 19:08 xarthurx

Additionally, as you can see in the image, the code highlight has a same background as the article, and is pretty hard to see. Is ProsePre (seems to be a pre-processing component) the right place to go?

I don't find any documentation for the background customization of the code section either...

xarthurx avatar Aug 31 '23 19:08 xarthurx

What <pre> is: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/pre

In short:

  • no whitespace collapsing
  • lines don't break if they are too long for the page

This is very useful for code blocks to keep each line a line

The prose component source: https://github.com/nuxt-modules/mdc/blob/main/src/runtime/components/prose/ProsePre.vue

I'd say that the <ProsePre> is not listed there, because it does not have its own Markdown syntax.

But feel free to open a PR to add a description to the docs.

nobkd avatar Aug 31 '23 21:08 nobkd

I think you can close it now, it's documented

ninedev-i avatar Jul 08 '24 11:07 ninedev-i

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 30 days.

github-actions[bot] avatar Nov 19 '24 02:11 github-actions[bot]