Skip to content

Commit

Permalink
First draft of doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gjtorikian committed Apr 22, 2015
1 parent accf734 commit 28bbead
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/highlighting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Highlighting

GitHub uses Linguist to power the syntax highlighting of code blocks. You know, the difference between this

```
var util = require('util');
var net = require('net');
var stream = require('stream');
var url = require('url');
```

and this

``` js
var util = require('util');
var net = require('net');
var stream = require('stream');
var url = require('url');
```

In order to syntax highlight a code block, you must provide a "language name" to the code block syntax of your Markup of choice.

For example, for Markdown, this would look like:

``` javascript

Whereas for AsciiDoc, this might be:

[source,javascript]

Below is a comprehensive list of of the language codes necessary for syntax highlighting a code block.

0 comments on commit 28bbead

Please sign in to comment.