docs(en): clarify code highlighting & fix typos #1604
Conversation
Removed extra spaces in code samples; highlighting didn't work with them included. Relates to #1534.
| @@ -392,7 +392,7 @@ Additionally, you can define a number of lines to focus using `// [!code focus:< | |||
| export default { | |||
| data () { | |||
| return { | |||
| msg: 'Focused!' // [!codeㅤ focus] | |||
| msg: 'Focused!' // [!codeㅤfocus] | |||
There was a problem hiding this comment.
This is not a space either. It's U+3164. Having such characters in source code is worse than having two spaces. It is more likely to go unnoticed than two spaces!
There was a problem hiding this comment.
Oh right, didn't see that - nor did my editor apparently! Thanks for pointing it out.
There was a problem hiding this comment.
Yeah, I missed that too. It is there in the current docs too. I'd missed them while reviewing earlier PRs. Gonna remove all those in #1615 itself. Removing two spaces won't work as it will make shiki highlight those blocks too. We can however add a note there that users should remove an extra space if copying.
There was a problem hiding this comment.
I think mentioning removing the extra spaces is helpful because it took me about 20 minutes to figure out why on earth it didn't work 😅
Removes extra spaces in code samples.
Relates to #1534.