Vocabulary: Document component capable of rendering markdown/code

Created on 19 Oct 2020  路  4Comments  路  Source: creativecommons/vocabulary

Description

A markdown rendering component would be really handy to have. We would then be able to render any other code snippets as well. Writing docs would also become a much smoother experience.

Alternatives

The community led versions may not have the option to customize the font-family according to our requirements. This remains to be seen and discussed.

Implementation

  • [x] I would be interested in implementing this feature.
internship improvement code low

Most helpful comment

@JipSterk unrelated, but i love your github avatar

All 4 comments

i would like to try and implement this

Go ahead @JipSterk!

@JipSterk unrelated, but i love your github avatar

@zackkrida @dhruvkb

Just to reiterate over this issue:

I did consider having this would be a great addition for us, but I now understand that the use cases would be rather limited. I've used vue-markdown, and I also overrode it with our own custom styles. It seems to work great!

Here's a screenshot:

Screenshot 2020-11-21 112124

Maybe, instead of having it as a separate component (which would be a near enough replica of vue-markdown, and would bloat our library size) we could just document it under the code typography section?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

panchovm picture panchovm  路  5Comments

dhruvkb picture dhruvkb  路  6Comments

zackkrida picture zackkrida  路  4Comments

zackkrida picture zackkrida  路  3Comments

zackkrida picture zackkrida  路  5Comments