search

node-red / flow-library

Node-RED Flow Library
Apache License 2.0
70 stars 44 forks source link

Markdown Renderer not coping with yaml #42

Closed marcus-j-davies closed 3 years ago

marcus-j-davies commented 3 years ago

Some instances of node red are being installed as plugins to Home Assistant. it is therefore, going to cause a few work arounds for nodes to detail some yaml guidance (due to the HA restrictive platform).

I have noticed that yaml fails to Render correctly.

Here is the yaml Markdown.

system_packages:
  - make
  - python3
  - g++
  - gcc
  - linux-headers
  - udev
npm_packages:
  - serialport
  - node-red-contrib-zwave-js

And here it is in the flows web page 🤷

image

I have noticed there is a PR for 2.0 of marked - would this bring the fix?

knolleary commented 3 years ago

Can you link to the node in question so we have something to look at?

marcus-j-davies commented 3 years ago

Sure thing.

https://github.com/zwave-js/node-red-contrib-zwave-js

knolleary commented 3 years ago

Thanks. I see it renders correctly on github and npm ... so hopefully "just" a question of updating the markdown formatter we have.

marcus-j-davies commented 3 years ago

yup, when these instances occur - the first thing I check is those mentioned.

marcus-j-davies commented 3 years ago

Hi,

Any update on this?

I note there is a long awaiting PR that may (or may not) resolve this issue with being able to render yaml code snippets in readme documents.

knolleary commented 3 years ago

I have confirmed the latest version of marked also renders the list differently to GitHub/npm. I have raised an issue against marked: https://github.com/markedjs/marked/issues/2019

marcus-j-davies commented 3 years ago

Closing.

See https://github.com/markedjs/marked/issues/2019#issuecomment-823503343 😞