Skip to content

Commit e2b3edf

Browse files
author
Jen Weber
authored
Merge pull request #38 from ember-learn/code-block-styleguide
Add info on fence code block styles
2 parents 5787272 + 5ee0905 commit e2b3edf

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,24 @@ In code samples:
7979
* Follow the [Ember Style Guide](https://github.com/emberjs/ember.js/blob/master/STYLEGUIDE.md).
8080
* Use double-quotes in templates, i.e., `<div class="awesome">{{foo-bar title="Tomster"}}</div>`.
8181
* Omit the boilerplate that Ember CLI generates, especially the `import Ember from 'ember'` at the top of every file.
82-
* In fenced code blocks, include the filename or language after the triple-backticks, like <code>&#96;&#96;&#96;routes/kittens.js</code> or <code>&#96;&#96;&#96;hbs</code>.
83-
* Write paths relative to the project root.
82+
* In fenced code blocks, write paths relative to the project root. e.g., `app/router.js`, `config/environment.js`
83+
* When writing a fenced code block with a filename, do so by writing the language name first followed by the file name within a data-filename block as shown below,
84+
85+
\`\`\` javascript {data-filename="app/router.js"}
86+
87+
\`\`\`
88+
89+
* When writing a fenced code block with diffs, do so by writing the patch information within a data-diff block as shown below,
90+
91+
\`\`\` javascript {data-filename="app/router.js" data-diff="-2,+3"}
92+
93+
\`\`\`
94+
95+
* All fenced code blocks should begin with a language code supported by [prism.js](http://prismjs.com/) so that they get highlighted properly when rendered. Here are some frequently used language codes,
96+
* bash
97+
* javascript
98+
* css
99+
* handlebars
84100

85101
When linking to API pages:
86102

0 commit comments

Comments
 (0)