Skip to content

Instantly share code, notes, and snippets.

@Mikulas

Mikulas/tips.md

Created July 20, 2013 10:58
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Mikulas/6044647 to your computer and use it in GitHub Desktop.
Save Mikulas/6044647 to your computer and use it in GitHub Desktop.
Download ZIP
Github Markdown Hacks
Raw
tips.md

Images

Inline image without link - simply wrap your images with <a></a>, preventing Github from creating its own link.

<a>![your caption](http://placehold.it/350x150)</a>

With link   Without link

Also note that images served over https:// are not cached, which is useful for changing content without actually editing the image url itself. Example: CI status badges

Spacing

Arbitrary pixel-perfect white space:

<img width="1337">

Huge gap follows: text after huge gap

As it does not have the src attribute, Github does not even wrap it in anchor.

Neat html features supported on Github

Definition lists:

<dl>
  <dt>Term</dt>
  <dd>definition</dd>
</dl>
Lorem ipsum dolor
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Text strike thru:

<del>Deprecated documentation</del>

Deprecated documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment