Loadingko742

Syntax highlighting in markdown

• Markdown Bash
• Link Syntax Markdown

Last updated by Dan Quinney on August 08, 2016 16:33

Mdshell requires only Bash and Perl, and builds HTML files from Markdown files. The name mdshell refers to the fact you can combine Markdown and Bash sub-shells in your blog posts to dynamically produce the HTML output. See full list on github.com. Codebase allows you to use markdown in various places such as ticket updates and notebook pages. Markdown is great because of its support of code blocks. We've tied this in with Codebase's powerful syntax highlighting to provide language specific code blocks To use the syntax highlighting, you'll need to specify the language that you're using.

Codebase allows you to use markdown in various places such as ticket updates and notebook pages. Markdown is great because of its support of code blocks. We've tied this in with Codebase's powerful syntax highlighting to provide language specific code blocks

To use the syntax highlighting, you'll need to specify the language that you're using. For example:

or:

Here's a full list of supported languages:

• Cucumber ('*.feature')
• abap ('*.abap')
• ada ('*.adb', '*.ads', '*.ada')
• ahk ('*.ahk', '*.ahkl')
• apacheconf ('.htaccess', 'apache.conf', 'apache2.conf')
• applescript ('*.applescript')
• as ('*.as')
• as3 ('*.as')
• asy ('*.asy')
• bash ('*.sh', '*.ksh', '*.bash', '*.ebuild', '*.eclass')
• bat ('*.bat', '*.cmd')
• befunge ('*.befunge')
• blitzmax ('*.bmx')
• boo ('*.boo')
• brainfuck ('*.bf', '*.b')
• c ('*.c', '*.h')
• cfm ('*.cfm', '*.cfml', '*.cfc')
• cheetah ('*.tmpl', '*.spt')
• cl ('*.cl', '*.lisp', '*.el')
• clojure ('*.clj', '*.cljs')
• cmake ('*.cmake', 'CMakeLists.txt')
• coffeescript ('*.coffee')
• console ('*.sh-session')
• control ('control')
• cpp ('*.cpp', '*.hpp', '*.c++', '*.h++', '*.cc', '*.hh', '*.cxx', '*.hxx', '*.pde')
• csharp ('*.cs')
• css ('*.css')
• cython ('*.pyx', '*.pxd', '*.pxi')
• d ('*.d', '*.di')
• delphi ('*.pas')
• diff ('*.diff', '*.patch')
• dpatch ('*.dpatch', '*.darcspatch')
• duel ('*.duel', '*.jbst')
• dylan ('*.dylan', '*.dyl')
• erb ('*.erb')
• erl ('*.erl-sh')
• erlang ('*.erl', '*.hrl')
• evoque ('*.evoque')
• factor ('*.factor')
• felix ('*.flx', '*.flxh')
• fortran ('*.f', '*.f90')
• gas ('*.s', '*.S')
• genshi ('*.kid')
• glsl ('*.vert', '*.frag', '*.geo')
• gnuplot ('*.plot', '*.plt')
• go ('*.go')
• groff ('*.(1234567)', '*.man')
• haml ('*.haml')
• haskell ('*.hs')
• html ('*.html', '*.htm', '*.xhtml', '*.xslt')
• hx ('*.hx')
• hybris ('*.hy', '*.hyb')
• ini ('*.ini', '*.cfg')
• io ('*.io')
• ioke ('*.ik')
• irc ('*.weechatlog')
• jade ('*.jade')
• java ('*.java')
• js ('*.js')
• jsp ('*.jsp')
• lhs ('*.lhs')
• llvm ('*.ll')
• logtalk ('*.lgt')
• lua ('*.lua', '*.wlua')
• make ('*.mak', 'Makefile', 'makefile', 'Makefile.*', 'GNUmakefile')
• mako ('*.mao')
• maql ('*.maql')
• mason ('*.mhtml', '*.mc', '*.mi', 'autohandler', 'dhandler')
• markdown ('*.md')
• modelica ('*.mo')
• modula2 ('*.def', '*.mod')
• moocode ('*.moo')
• mupad ('*.mu')
• mxml ('*.mxml')
• myghty ('*.myt', 'autodelegate')
• nasm ('*.asm', '*.ASM')
• newspeak ('*.ns2')
• objdump ('*.objdump')
• objectivec ('*.m')
• objectivej ('*.j')
• ocaml ('*.ml', '*.mli', '*.mll', '*.mly')
• ooc ('*.ooc')
• perl ('*.pl', '*.pm')
• php ('*.php', '*.php(345)')
• postscript ('*.ps', '*.eps')
• pot ('*.pot', '*.po')
• pov ('*.pov', '*.inc')
• prolog ('*.prolog', '*.pro', '*.pl')
• properties ('*.properties')
• protobuf ('*.proto')
• py3tb ('*.py3tb')
• pytb ('*.pytb')
• python ('*.py', '*.pyw', '*.sc', 'SConstruct', 'SConscript', '*.tac')
• rb ('*.rb', '*.rbw', 'Rakefile', '*.rake', '*.gemspec', '*.rbx', '*.duby')
• rconsole ('*.Rout')
• rebol ('*.r', '*.r3')
• redcode ('*.cw')
• rhtml ('*.rhtml')
• rst ('*.rst', '*.rest')
• sass ('*.sass')
• scala ('*.scala')
• scaml ('*.scaml')
• scheme ('*.scm')
• scss ('*.scss')
• smalltalk ('*.st')
• smarty ('*.tpl')
• sourceslist ('sources.list')
• splus ('*.S', '*.R')
• sql ('*.sql')
• sqlite3 ('*.sqlite3-console')
• squidconf ('squid.conf')
• ssp ('*.ssp')
• tcl ('*.tcl')
• tcsh ('*.tcsh', '*.csh')
• tex ('*.tex', '*.aux', '*.toc')
• text ('*.txt')
• v ('*.v', '*.sv')
• vala ('*.vala', '*.vapi')
• vbnet ('*.vb', '*.bas')
• velocity ('*.vm', '*.fhtml')
• vim ('*.vim', '.vimrc')
• xml ('*.xml', '*.xsl', '*.rss', '*.xslt', '*.xsd', '*.wsdl')
• xquery ('*.xqy', '*.xquery')
• xslt ('*.xsl', '*.xslt')
• yaml ('*.yaml', '*.yml')

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.

Examples

Markdown Bash

Syntax guide

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

Headers

Emphasis

Lists

Unordered

Ordered

Images

Links

Blockquotes

Inline code

GitHub Flavored Markdown

GitHub.com 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 GitHub.com.

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!

Tables

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:

SHA references

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

Issue references within a repository

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 http://www.github.com/) will be automatically converted into a clickable link.

Strikethrough

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

Emoji

GitHub supports emoji!

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

Link Syntax Markdown

Last updated Jan 15, 2014