Github Issue Markdown

Posted on  by admin

To mention other team mates in an Issue, use the @ character and then begin typing the individual's GitHub username. This will cause a dropdown of users to appear where you can select your team mate. Once mentioned, they will receive a notification with your comment. I've run into this issue as well. Github will not allow you to upload anything over 10Mb. However, they offer an optional large file storage service specifically for audio/video/etc. This is what you want. Browse other questions tagged github markdown github-flavored-markdown or ask your own question.

A realistic implementation of various Markdown specifications as a flexible, drop-in alternative for language-gfm. Adds smart context-aware behavior to lists, and keyboard shortcuts for inline emphasis and links/images.


  1. Install language-markdown via either
  • your terminal: apm install language-markdown
  • the Atom GUI: Atom > Settings > Install > Search for language-markdown

Github Markdown Style

  1. Select language-markdown as your Markdown grammar. Open a Markdown file and
  • press ctrl+shift+L and choose 'Markdown'
  • choose 'Markdown' from the grammar selection interface in the bottom right-hand corner of the window

To avoid conflicts this package tries to disable the core package language-gfm. If you run into any issue, make sure you've selected the correct grammar.

Supported grammars

  • CommonMark Markdown
  • Github Flavored Markdown (including AtomDoc)
  • Markdown Extra
  • CriticMark annotation
  • Front Matter (yaml, toml and json)
  • R Markdown

Additional features

Github markdown issue link
  • Smarter lists
    • Automatically create new list-items when pressing enter
    • Indent or outdent list-items by pressing tab or shift+tab
    • Toggle tasks with cmd+shift+x or ctrl+shift+x
    • Remove empty trailing list-items when pressing enter
  • Add shortcuts (via _, * and ~) for toggling inline-emphasis and strike-through on selected text
  • Add shortcuts for converting selected text to a link (via @) or an image (via !)
  • Supports embedded HTML- and Liquid-tags
  • Embedded math functions (via language-latex and language-mathematica)

Syntax-theme support

By default, most syntax-themes only provide basic styling for .markup classes. This package provides additional, more specific classes which are supported by the following syntax-themes:

  • minimal-syntax (light, high-contrast)
  • minimal-syntax-dark (dark, high-contrast)
  • pen-paper-coffee (light, low-contrast)
  • pubster-syntax (dark, high-contrast)
  • one-o-eight-syntax (various, medium-contrast)
  • east-end-syntax (light, medium-contrast)
  • east-end-notebook-syntax (light/lined, medium-contrast)

If you are interested in adding support for all .markup classes to your syntax-theme, take a look at the relevant section in the contribution guide.


If you run into any issues, consult the F.A.Q. first. Amongst other things, this document contains information about common issues involving:

  • spell-check
  • autocompletion
  • syntax-highlighting
  • whitespace


If you want to contribute to this package, have a look at the contribution guide.

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

What you will learn:

  • How the Markdown format makes styled collaborative editing easy
  • How Markdown differs from traditional formatting approaches
  • How to use Markdown to format text
  • How to leverage GitHub’s automatic Markdown rendering
  • How to apply GitHub’s unique Markdown extensions

What is Markdown?

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

You can use Markdown most places around GitHub:

  • Comments in Issues and Pull Requests
  • Files with the .md or .markdown extension

For more information, see “Writing on GitHub” in the GitHub Help.


It's very easy to make some words bold and other words italic with Markdown. You can even link to Google!

Syntax guide

Here’s an overview of Markdown syntax that you can use anywhere on or in your own text files.









Github Issue Markdown Free

Inline code

GitHub Flavored Markdown uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on

Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.

Syntax highlighting

Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:

You can also simply indent your code by four spaces:

Here’s an example of Python code without syntax highlighting:

Task Lists

If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!


You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe :

Would become:

First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent in the second column

SHA references

Any reference to a commit’s SHA-1 hash will be automatically converted into a link to that commit on GitHub.


Github Markdown Tutorial

Issue references within a repository

Github Issue Markdown

Any number that refers to an Issue or Pull Request will be automatically converted into a link.

Username @mentions

Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.

Automatic linking for URLs

Any URL (like will be automatically converted into a clickable link.


Any word wrapped with two tildes (like ~~this~~) will appear crossed out.


GitHub supports emoji!

To see a list of every image we support, check out the Emoji Cheat Sheet.

Last updated Jan 15, 2014