-
-
Notifications
You must be signed in to change notification settings - Fork 732
Code Highlight markup and Link colouration fix constants.adoc #657
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
Conversation
Code Highlight markup and Link colouration fix
Co-Authored-By: per1234 <[email protected]>
Thanks! |
@per1234 Again a question on this: I somehow remeber that you told me once not to include links into the backticks because the links are already highlighted as links (Not as code). Or did I misunderstand something there? |
@SeppPenner you're referring to #546. Luckily, @animeshsrivastava24 found a solution to that. Previously, we were trying to use this style of markup to linkify code words with backticks:
The problem was that for some reason this caused the link coloration of the text to be suppressed when the content was rendered on arduino.cc, so you could only tell that text was a link by hovering the mouse pointer over it. For this reason, when we wanted to make a link obvious we had to avoid using backticks on the code words:
Which was unfortunate. @animeshsrivastava24 discovered that if you use this markup:
then you get the code highlighting and link coloration both, like this: My idea is that we can use both styles of markup, as I explain in detail here: |
I can remeber that, yeah. It didn't work as expected.
Good to know, I just wanted to be sure that this is correct. Your idea from #546 (comment) seems the best way to go for this. I agree with you that multiple occurences of links within a certain amount of text will make it probably unreadable as you stated there. That was something I didn't think about when I created #462. |
Code Highlight markup and Link colouration fix
Ref #546
@per1234 Please review does this matches with what you mentioned in the comment #546 (comment)