Github Markdown Language List



  1. Github Markdown Code
  2. Github Markdown Language Listen

This tutorial covers Markdown lists - Ordered, unordered, syntax with examples. I'm Jason, a web applications developer in the Denver, Colorado area. Markdown doesn't natively support underlined text. If necessary you can hardcode it with the HTML tag ins (underlined text), however, it is inadvisable to do so. There are a few different ways to display links with markdown markup, but to keep some.

A collection of Markdown code and tricks that were tested to work in Gist.

This and all public gists in https://gist.github.com/ww9 are Public Domain. Do whatever you want with it including , no need to credit me.

Todo

  • Reformat this whole document and assimilate these:
    • https://gist.github.com/t-nissie/9580883 (Add images, secret gists, anti-spam protection)
    • https://gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e#file-mathjax-ipynb (Python notebook, Math syntax)
Table of Contents

Task lists

Result:

  • Task 1
  • Task 2
  • Task 3

Collapsible content (spoilers)

Content between <details> and </details> is hidden. You need to escape HTML tags them.

Headers

H2

Github Markdown Code

H3

H4

H5
H6

Alternatively, for H1 and H2, an underline-ish style:

Alt-H2

Emphasis

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

Github markdown code

Lists

  1. First ordered list item
  2. Another item
  • Unordered sub-list.
  1. Actual numbers don't matter, just that it's a number

  2. Ordered sub-list

  3. And another item.

    Some text that should be aligned with the above item.

  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

Links

There are two ways to create links.

Or leave it empty and use the link text itself

URLs and URLs in angle brackets will automatically get turned into links.http://www.example.com or http://www.example.com and sometimesexample.com (but not on Github, for example).

Some text to show that the reference links can follow later.

Images

Github Markdown Language Listen

Here's our logo (hover to see the title text):

Inline-style:

Reference-style:

Code and Syntax Highlighting

Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and Markdown Here -- support syntax highlighting. Markdown Here supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the highlight.js demo page.

Inline code has back-ticks around it.

Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting.

Again, to see what languages are available for highlighting, and how to write those language names, see the highlight.js demo page.

Tables

Tables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them. They are an easy way of adding tables to your email -- a task that would otherwise require copy-pasting from another application.

Colons can be used to align columns.

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

MarkdownLessPretty
Stillrendersnicely
123

Blockquotes

Blockquotes are very handy in email to emulate reply text.This line is part of the same quote.

Github markdown guide

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can putMarkdown into a blockquote.

Inline HTML

You can also use raw HTML in your Markdown, and it'll mostly work pretty well.

Definition list
Is something people use sometimes.
Markdown in HTML
Does *not* work **very** well. Use HTML tags.

Horizontal Rule

Three or more...

Hyphens

ListGithub markdown language list

Asterisks

Underscores

Line Breaks

My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what happens. You'll soon learn to get what you want. 'Markdown Toggle' is your friend.

Here are some things to try out:

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also begins a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the same paragraph.

(Technical note: Markdown Here uses GFM line breaks, so there's no need to use MD's two-space line breaks.)

YouTube Videos

They can't be added directly but you can add an image with a link to the video like this:

Or, in pure Markdown, but losing the image sizing and border:

TeX Mathematical Formulae

A full description of TeX math symbols is beyond the scope of this cheatsheet. Here's a good reference, and you can try stuff out on CodeCogs. You can also play with formulae in the Markdown Here options page.

Here are some examples to try out:

The beginning and ending dollar signs ($) are the delimiters for the TeX markup.

If you are missing a server please create a pull request in GitHub against this markdown document

LanguageMaintainerRepositoryImplementation Language
1C EnterpriseContributorsBSL Language ServerJava
ActionScript 2.0Adam VernonAS2 Language SupportTypeScript
Ada/SPARKAdaCoreada_language_serverAda
AntlrKen DominoAntlrvsixC#
API ElementsVincenzo Chianese(@XVincentX)vscode-apielementsTypeScript
Apache CamelContributorsApache Camel Language ServerJava
ApexSalesforceVS Code Apex extensionTypeScript
BallerinaBallerina.ioBallerina Language ServerJava
BashMads HartmannBash Language ServerTypeScript
BrightScript/BrighterScriptRokuCommunitybrighterscriptTypeScript
C#OmniSharpcsharp-language-server-protocolC#
C++MSVS Code C++ extensionC++
C++/clangLLVM ProjectclangdC++
C/C++/Objective-CJacob Dufault, MaskRay, topisanicqueryC++
C/C++/Objective-CMaskRaycclsC++
CSS/LESS/SASSMSvscode-css-languageserverTypeScript
CeylonJohn Vasileffvscode-ceylonCeylon
ClojureCase Nelsonclojure-lspClojure
IBM Enterprise COBOL for z/OSBroadcomCOBOL Language SupportJava
IBM High Level AssemblerBroadcomHLASM Language SupportC++
IBM High Level AssemblerIBMIBM Z Open Editor VS Code extensionJava
IBM Enterprise COBOL for z/OSIBMIBM Z Open Editor VS Code extensionJava
CodeQLGitHubcodeqlJava
CWLRabixBentenPython
Crane PHPHvyIndustriesVS Code ExtensionTypeScript
CrystalElbaz JulienCrystallineCrystal
CrystalRyan L. BellScryCrystal
DJan Jurzitzaserve-dD
DLaurent TréguierD Language ServerD
DartDart TeamDart SDKDart
Data PackSPGodingData-pack Language ServerTypeScript
DelphiEmbarcaderoProprietary (DelphiLSP)Delphi and C
DockerfilesRemy Suendockerfile-language-serverTypeScript
DreamMakerSpaceManiacDreamMaker Language ServerRust
ErlangOTP, Vlad DumitrescusourcerErlang
ErlangRoberto Aloi and Contributorserlang_lsErlang
ElixirElixir LSPelixir-lsElixir
ElmKolja LampeelmLSTypescript
EmberEmber communityember language serverTypeScript
F#@georgewfraserF# Language ServerF#
F#@Krzysztof-Cieslak & ContributorsFsAutoCompleteF#
FortranChris Hansenfortran-language-serverPython
GLSLSven-Hendrik Haase (@svenstaro)glsl-language-serverC++
GaugeGaugeGauge Language ServerGo
GDScriptGodotEngineGodotC++
GluonGluonGluon Language ServerRust
GoGo TeamgoplsGo
GoSourcegraphsourcegraph-goGo
GraphQLGraphQL FoundationOfficial GraphQL Language ServerTypeScript
GraphQLMayank Agarwal (@Mayank1791989)GQL Language ServerJavaScript
GroovyPalantirgroovy-language-serverJava
GroovyProminic.NETGroovy Language ServerJava
GroovyVsCode Groovy LintVsCode Groovy Lint Language ServerTypeScript
HTMLMSvscode-html-languageserverTypeScript
HaskellAlan ZimmermanHaskell Language Server (HLS)Haskell
HaxeHaxe FoundationHaxe Language ServerHaxe
HLSLTim JonesHLSL ToolsC#
IsabelleMakarius WenzelsourcesScala
JSONMSvscode-json-languageserverTypeScript
Java (Eclipse)Eclipse, RedHatEclipse JDT LSJava
Java@georgewfraserJava Compiler (javac) API-based Java supportJava
Javascript FlowFacebook, Inc.flowOCaml, JavaScript
Javascript Flowflowtypeflow-language-server(deprecated)JavaScript, Flow
Javascript-TypescriptSourcegraphjavascript-typescriptTypeScript
JuliaContributorsJulia language serverJulia
Kerboscript (kOS)John Chabotkos-language-serverTypescript
Kotlin@fwcdkotlin-language-serverKotlin
Language Server RobotTypeCobolTeamTypeCobol Language Server RobotC#
Language ToolAdam VosslanguagetoolJava
LaTeXEric Förstertexlab
LuaKyle McLamblua-lspLua
Lua最萌小汐lua-language-serverLua
MSBuildAdam Friedmanmsbuild-project-tools-vscodeTypeScript
NimPeter Munch-EllingsennimlspNim
OCaml/Reasonfreebroccoloocaml-language-serverTypeScript
OCaml/ReasonOCaml LabsocamllspOCaml
openVALIDATIONopenVALIDATIONov-language-serverTypeScript
PapyrusJoel Daypapyrus-langC#
PerlGRICHTERPerl::LanguageServerPerl
PHPBen MewburninteliphenseTypeScript
PHPFelix Beckerphp-language-serverPHP
PHPTom GerritsSerenataPHP
PHPTyson AndrePhanPHP
PHPUnitRecca0120phpunit-language-serverTypeScript
IBM Enterprise PL/I for z/OSIBMIBM Z Open Editor VS Code extensionJava
PolymerPolymer Teampolymer-editor-serviceTypeScript
PowerPC AssemblyNoah FieldsPowerPC SupportTypeScript
PowerShellMSPowerShell Editor ServicesC#
PromQLTobias Guggenmospromql-langserverGo
PureScriptNicholas Wolversonpurescript-language-serverPureScript
PuppetLingua Pupulipuppet language serverRuby
PythonFabio ZadroznyPyDev on VSCodeJava, Python
PythonPalantir Technologiespython-language-serverPython
PythonMSpython-language-serverC#
Q#MSQ# Language ServerC#
RREditorSupportR language serverR
RacketJay McCarthyracket-langserverRacket
RAMLRAML Workgroupraml-language-server Work in Progress
ReasonMLJared Forsythreason-language-serverOCaml
RedbitbeginredlangserverRed
RELStefan Schlichthärlerel-lsC++
ReScriptrescript-langrescript-vscodeTypeScript
Robot FrameworkTomi TurtiainenVSCode RF language serverTypeScript
Robot FrameworkRobocorprobotframework-lspPython
RubyFred SnydersolargraphRuby
RubyFumiaki MATSUSHIMAlanguage_server-rubyRuby
RubyDmitry PetrashkosorbetRuby
RubyRafał ŁasochaorbacleRuby
RubyKurt Werleruby_language_serverRuby
RustJonathan TurnerRust Language ServerRust
RustAleksey KladovRust AnalyzerRust
T-SQLMSVS Code SQL extensionTypeScript, Binary
ScalaIulian Dragosdragos-vscode-scalaScala
ScalaScalametaMetalsScala
Smalltalk/PharoBenoît VerhaeghePharo Language ServerPharo
SPARQLStardog UnionSPARQL Language ServerTypeScript
StylableWix.comstylable/language-serviceTypeScript
SvelteUnwrittenFunsvelte-language-serverTypeScript
SwiftAppleSourceKit-LSPSwift
SyslANZ BankSysl LSPGo
SystemVerilogdalancesvlsRust
TerraformJulio Tain Sueirasterraform-lspGo
TerraformHashiCorpterraform-lsGo
Tibbo BasicTibbotibbo-basicTibbo Basic
TTCN-3NokianttGo
TurtleStardog UnionTurtle Language ServerTypeScript
TypeCobolTypeCobolTypeCobol language serverC#
TypeScriptTypeFoxtypescript-language-serverTypeScript
ValaBen Iofel, Princeton Ferrovala-language-serverVala
VDM-SL, VDM++, VDM-RTNick BattleVDMJ-LSPJava
VHDLOlof Kraighervhdl_lsRust
Vimliamccovim-language-serverTypescript
VisualforceSalesforceVS Code Visualforce extension
VuePine Wu & @HerringtonDarkholmevuejs/veturTypeScript
WebAssemblyDarin Morrisonwasm-language-serverRust
Wolfram Language (Mathematica)kenkangxgwelsp-wlWolfram Language
WXMLQiming Zhaowxml-languageserverTypeScript
XMLIBMXML Language ServerJava
XMLRed Hat Developers and Angelo ZERRXML Language Server (LemMinX)Java
Xtext language frameworkEclipseEclipse XtextJava
YAML (with JSON schemas)Adam Vossvscode-yaml-languageserviceTypeScript
YAMLRed Hat Developersyaml-language-serverTypeScript
YANGYang toolsyang-lspXTend
*mattnefm-langserverGo