remarkjs / react-markdown

Markdown component for React
https://remarkjs.github.io/react-markdown/
MIT License
13.27k stars 876 forks source link

rermarkgfm showing tasklist wrong #817

Closed OpenJarvisAI closed 9 months ago

OpenJarvisAI commented 9 months ago

Initial checklist

Affected packages and versions

1.2

Link to runnable example

ferf

Steps to reproduce

ferfer

Expected behavior

gerger

Actual behavior

gferg

image image

bad and odd.

Runtime

Node v17

Package manager

npm 8

OS

Windows

Build and bundle tools

Rollup

remcohaszing commented 9 months ago

This issue contains no information and can't be acted upon.

OpenJarvisAI commented 9 months ago

@remcohaszing Can your lib render task list right???

ChristianMurphy commented 9 months ago

Yes, you can see working example on the demo page https://remarkjs.github.io/react-markdown/

Take some time to frame your question (https://github.com/remarkjs/.github/blob/main/support.md#asking-quality-questions) A runnable example of what you are trying inside a sandbox gives context on what you are trying to do in the code.

OpenJarvisAI commented 9 months ago
image

Am not sure you guys like telling something that obviously wrong.

ChristianMurphy commented 9 months ago

@OpenJarvisAI there is a GFM toggle on the demo page. Toggle it on.

My best guess right now, is like on the demo site. You ignored the step in the readme to switch GFM on https://github.com/remarkjs/react-markdown#use

If you want additional support, follow the guidance from my last message on how to frame a question and provide context. Stop wasting maintainer time by posting without actually trying anything.

OpenJarvisAI commented 9 months ago

I am a 10 years front-end developer, and I have set

<Markdown remarkPlugins={[remarkGfm]}>{markdown}</Markdown>

plugin on,not work

ChristianMurphy commented 9 months ago

I am a 10 years front-end developer

Great, act like it then 🙂

<Markdown remarkPlugins={[remarkGfm]}>{markdown}</Markdown>

That doesn't answer my question, how are you running it? There are millions of possible build tools. Here is a minimal reproducible example showing it working with latest vite, react-markdown, and remark-gfm https://stackblitz.com/edit/github-j5vjzd?file=package.json,src%2Fapp.tsx

Show a minimal reproducible example of what you are seeing.

OpenJarvisAI commented 9 months ago

@ChristianMurphy hi, am just using nextjs.

OpenJarvisAI commented 9 months ago

Oh, I looked it jusst like mine, the blaxk dot is can be invisiable?

look at github

ChristianMurphy commented 9 months ago

am just using nextjs

There are 14 major versions of next and many possible build configurations, share a reproducible example so we can help you. https://next.new could be a starter.

the black dot is can be invisible?

I don't understand what you are asking. What black dot?

Broadly speaking you can style HTML to look like anything. Check your style sheet to see how you are customizing the page appearance, you may be styling check lists to not appear.

Tailwind CSS is particularly well known to have styles which break markdown rendering by default.

OpenJarvisAI commented 9 months ago

@ChristianMurphy Can't u just look at the exaple you kindly prepared? Does they looks exact like github???

image image

I just want the black dots disappear, it's very very very ugly!

ChristianMurphy commented 9 months ago

@OpenJarvisAI that is how markdown works, it is specified in the standard. https://github.github.com/gfm/#task-list-items-extension-

Markdown does not specify the styles, that is completely up to you and your application. If you want to style it exactly how GitHub does apply a stylesheet like https://github.com/sindresorhus/github-markdown-css or you can make your own https://www.w3schools.com/CSS/css_list.asp.

OpenJarvisAI commented 9 months ago

I have never (or very rare) see a markdown checklist have black dots before.

I am prefer just using people usually understand way, besides, I am already using gfm and you saying If you want to style it exactly how GitHub does which I am very hard to understand.

Nevertheless, this is the very unique markdown default styling looks so abnormal.

How can I just applying the css linked above to my react & next13 project?

(Honestly, am not a frontend developer)

ChristianMurphy commented 9 months ago

I have never (or very rare) see a markdown checklist have black dots before.

Because almost everyone applies a stylesheet to theme content to match their application.

Nevertheless, this is the very unique markdown default styling looks so abnormal.

That is how HTML looks 🤷 If you want it to look different style it.

How can I just applying the css linked above to my react & next13 project?

By following the Next JS guide on adding external stylesheets https://nextjs.org/docs/pages/building-your-application/styling/css-modules#import-styles-from-node_modules

OpenJarvisAI commented 9 months ago

well, why not add right css as default?

ChristianMurphy commented 9 months ago

There is no "right" CSS. Every application can have its own look and feel, it is a non-goal for react-markdown to dictate how your app should look.

Broadly speaking, remarkjs and react-markdown follow a variation on the Unix Philosophy.

react-markdown renders CommonMark to plain React components (hyperscript).

There are plenty of extension points to add other syntax, components, and style attributes. You are welcome to create a component/module/plugin which has the look and feel that you want for your app and to share it with others.

OpenJarvisAI commented 8 months ago

I get it if you saying unix style. Make something just work nothing more, I agree.

But, as for an UI, can just make some default options or, at least, write some default configs users can do with it?

Rather than give me some render result with list of task box start with ugly dots.

OpenJarvisAI commented 8 months ago

I sitll don't know , how to set css in it.

remcohaszing commented 8 months ago

When it comes to web development, React is quite advanced. I suggest you start with a tutorial to understand the basics of HTML, then work up to CSS, then JavaScript, then React. A good starting point would be https://www.w3schools.com/html/default.asp.

OpenJarvisAI commented 8 months ago

OK, so if I have to set all

  • css for this markdown? Don't think it will overwrite all other components?

  • wooorm commented 8 months ago

    Please take some time to learn markdown and CSS. You write markdown here on GH, that <li> gets interpreted. And for the CSS, learn how to write good CSS and do everything you want.

    Locking this. This is not free customer service.