Skip to content

Instantly share code, notes, and snippets.

@awaism551
Last active August 19, 2023 18:55
Show Gist options
  • Save awaism551/f0f76d768763013822ee6cb281d395dd to your computer and use it in GitHub Desktop.
Save awaism551/f0f76d768763013822ee6cb281d395dd to your computer and use it in GitHub Desktop.
All shortcuts and imp info about markdown files is being added in this gist

Basic Info

John Gruber and Aaron Swartz in 2004 created the Markdown language with the idea of enabling people “to write using easy to read and write plain text format and with the option of converting it to XHTML or HTML.

Finding Headers Quickly

  • vscode outline
  • go to header in current file, ctrl+shift+o
  • go to header in workspace, ctrl+t
  • Path to Header GFM

Md files code snippets

  • code snippets from command pallete in vscode by shortcut, ctrl+shift+p -> snippets->insert snippet

Other features of Md syntax

  • bold syntax

  • italic

  • strike through word

  • This is bold and nested italic text

  • All bold and italic

  • This is a subscript text

  • This is a superscript text

  • Quoting Code within a line

  • this is code
    block
    
  • inserting images here Awais Pic

  • local links validation in md for vscode

  • Find All References to headers and links

  • Renaming headers and links

  • automatic link updates on file move or rename

  • preview md, locking preview, editor and preview scroll sync

  • using own css in md preview

  • Keep trailing whitespace in order to create line breaks

  • md preview security, only allows https by default but it can be overridden in settings

Color schemes

visibility of colors is supported in comments, discussions and github pull requests
The background color is #0969DA for light mode and rgb(9, 105, 218) for dark mode.

Links

  • This site was built using GitHub Pages.
  • if the url is present at some other place and you want to use that url and don't want to copy here again then
  • Local Links would also work in that way, like to open webframeworks.txt file whose link is present at the bottom of the file
    StackOverflow
    WebFrameworks File

Relative Links

Contribution guidelines for this project

Adding Images

Screenshot of a comment on a GitHub issue showing an image, added in the Markdown, of an Octocat smiling and raising a tentacle.

Specifying the theme an image is shown to

Shows an illustrated sun in light mode and a moon with stars in dark mode.

Lists

Unordered Lists

  • George Washington
  • John Adams
  • Thomas Jefferson

Ordered Lists

  1. James Madison
  2. James Monroe
  3. John Quincy Adams

Nested List Items

  1. First list item
    • First nested list item
      • Second nested list item

Task Lists

Mentioning people and teams

@awaism551 What do you think about these updates?

FootNotes

Here is a simple footnote Example [Stackoverflow]1

A footnote can also have multiple lines2.

Alerts

Note

Highlights information that users should take into account, even when skimming.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Some versions of md

GFM

github flavored markup

CommonMark

Vscode

Multi-Markdown

Places where it is used

Stackoverflow Github issues github comments, discussions, pull requests webex

Features

  • simple syntax
  • Platform Independent
  • portability
  • Version Control
  • Accessibility

vscode supports CommonMark md syntax

Not Covered

how can be converted to html can we use md files in email pdf conversion can also be done??directly or first to html and then to pdf by using any markdown application like Dillinger? markdown application such as Dillinger, markdown processors,

Footnotes

  1. My reference

  2. To add line breaks within a footnote, prefix new lines with 2 spaces.
    This is a second line.

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