Last Updated: February 25, 2016
·
1.814K
· sgtom42

Markdown Syntax on Github

Browsing through some pro tips on coderwall I found this very good guideline for coding in Java:
https://github.com/47deg/coding-guidelines/tree/master/java

I was wondering how this was done as the ".md" file extension was new to me.

This brought me to the description of markdown:
http://daringfireball.net/projects/markdown/syntax

Looks like a very good format for documenting things and integrates well with github. Sounds like an excellent combination to me :).

2 Responses
Add your response

GitHub takes it one step further by adding a few developer nicities such as fences for code and inline code.

http://github.github.com/github-flavored-markdown/

For example, `this is inline code` and

```

This is multi-line

fenced code.

You can specify language at the start via "```js" or whatever language you are using.

```

over 1 year ago ·

Thanks a lot for the addition :-)

over 1 year ago ·