Skip to content

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

Merged
merged 2 commits into from
Jul 12, 2019

Conversation

animeshsrivastava24
Copy link
Contributor

@animeshsrivastava24 animeshsrivastava24 commented Jul 10, 2019

Code Highlight markup and Link colouration fix
Ref #546
@per1234 Please review does this matches with what you mentioned in the comment #546 (comment)

Code Highlight markup and Link colouration fix
@per1234 per1234 merged commit d2c5e69 into arduino:master Jul 12, 2019
@per1234
Copy link
Collaborator

per1234 commented Jul 12, 2019

Thanks!

@SeppPenner
Copy link
Contributor

@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?

@per1234
Copy link
Collaborator

per1234 commented Jul 14, 2019

@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:

link:../../../functions/digital-io/pinmode[`pinMode()`]

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:

link:../../../functions/digital-io/pinmode[pinMode()]

Which was unfortunate. @animeshsrivastava24 discovered that if you use this markup:

`link:../../../functions/digital-io/pinmode[pinMode()]`

then you get the code highlighting and link coloration both, like this:
pinMode()

My idea is that we can use both styles of markup, as I explain in detail here:
#546 (comment)

@SeppPenner
Copy link
Contributor

Previously, we were trying to use this style of markup to linkify code words with backticks:

I can remeber that, yeah. It didn't work as expected.

Which was unfortunate. @animeshsrivastava24 discovered that if you use this markup:

link:../../../functions/digital-io/pinmode[pinMode()]
then you get the code highlighting and link coloration both, like this:
pinMode()

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants