Comments (5)
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...
from dash-codelab-tutorials.
I've put 1. and 3. only for completeness. 2. Is the only one we have to standardize.
from dash-codelab-tutorials.
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 import * as Dash from 'dash'
no longer stand-alone as it is in your item 3 above). I guess we'd need others to chime in to break the tie on this.
from dash-codelab-tutorials.
@cloudwheels, perhaps you could weigh in on this. It's not a big deal, but curious to hear your thoughts.
from dash-codelab-tutorials.
Agreeing on @riongull's suggestion, implemented with commit 97cd569.
from dash-codelab-tutorials.
Related Issues (4)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from dash-codelab-tutorials.