Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proper Way to Color Text (HTML not working) #1665

Closed
piacenti opened this issue Dec 7, 2020 · 3 comments · Fixed by #1805
Closed

Proper Way to Color Text (HTML not working) #1665

piacenti opened this issue Dec 7, 2020 · 3 comments · Fixed by #1805
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@piacenti
Copy link

piacenti commented Dec 7, 2020

Question
What is the proper way to color documentation text?

Installation

  • Operating system: macOS
  • Build tool: Gradle v6.6.1
  • Dokka version: 1.4.20

Additional context
I have a class that performs highlighting and I would like to add an example of what the highlighted stuff should look like in the docs. Markdown doesn't supports coloring directly through any custom syntax but it should through html. However, no html I've tried inputting seems to render correctly.
Something as simple as

*
*<span style="color:darkgoldenrod">test</span>
*

renders as plain html rather than rendered html

@piacenti piacenti added the question A user question, can be resolved if the question is answered/resolved label Dec 7, 2020
@msink
Copy link
Contributor

msink commented Dec 7, 2020

This is not supported on github:
github/markup#369

@MarcinAman
Copy link
Contributor

Possible work-around would be to include an image as this is supported by markdown

@piacenti
Copy link
Author

piacenti commented Dec 9, 2020

@MarcinAman that's what I'm doing for now

@MarcinAman MarcinAman linked a pull request Mar 25, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question A user question, can be resolved if the question is answered/resolved
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants