-
Notifications
You must be signed in to change notification settings - Fork 3
Inconsistent use of single and triple backticks for codeblocks. #5
Comments
Yeah, it's pretty inconsistent across the whole web to be honest, but I think it's uncontroversial to use single back ticks for inline files/directories/commands/etc and triple back ticks for code blocks. Regarding your specific suggestions, I would lean more towards single line shell commands to be inline but let me go review the examples in this repo and think it over... |
I've put 1. and 3. only for completeness. 2. Is the only one we have to standardize. |
I just read through the updated tutorial now that it's hosted and yeah, we definitely need to come up with a consistent method. The differences are very obvious on this Codeblock site because it formats code blocks with black background and inline code with gray. I personally prefer to see a code block only when there's a multiline block of code (Typescript) or code output, I think code blocks are overkill for both single-line shell instructions and single-line TS/JS code, which is why I refactored step 6 of the tutorial to be what it is now (with the |
@cloudwheels, perhaps you could weigh in on this. It's not a big deal, but curious to hear your thoughts. |
Agreeing on @riongull's suggestion, implemented with commit 97cd569. |
The use of ` and ``` is really inconsistent at the moment. We should determine some kind of convention.
So here is what I would suggest:
Examples:
Open the file
dir1/dir2/file1
, edit it and pressCtrl
+S
to save.To install dash execute:
npm install --save-dev dash
Import DashSDK with:
I haven't found any "official conventions", so this is just a suggestion.
The text was updated successfully, but these errors were encountered: