Skip to content

Latest commit

 

History

History
148 lines (105 loc) · 3.76 KB

README.md

File metadata and controls

148 lines (105 loc) · 3.76 KB
Raw

markdown-language-notes

Very helpful notes about using the markdown language on the Atom editor. Second level subheadings in this README.md are ordered by how often the feature/note is expected to be used.

Table of Contents

Links

To The Same Document

Just one # for all heading sizes, no space between # and anchor name, anchor tag names must be lowercase, and delimited by dashes if multi-word.

[click on this link](#my-multi-word-header)
### My Multi Word Header

You can use Atom package markdown-toc-auto to generate a table of contents.

Inline Links

[I'm an inline-style link](https://www.google.com)
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")

Relative links

A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

Relative links example

Source

Raw URLs

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

Footnotes

The references should always be placed at the very bottom of the document, as it can skip text?

Here is a simple footnote[^1]. With some additional text after it.

[^1]: My reference.

Info Strings

docs/info-strings.md Contains a list of info strings for code fences.

GitHub Flavored Markdown Spec

https://github.github.com/gfm/

Code fences

Code fences look like this:

```
I am within a code fence.
```

This thing seems to work too (I don't know why). You should also check this in the source file for this README.md:

````markdown
```
I am within many code fences.
```
````

Double Backticks

To include a literal backtick character within a code span, you can use multiple backticks as the opening and closing delimiters:

``There is a literal backtick (`) here.``

The backtick delimiters surrounding a code span may include spaces — one after the opening, one before the closing. This allows you to place literal backtick characters at the beginning or end of a code span:

A single backtick in a code span: `` ` ``

A backtick-delimited string in a code span: `` `foo` ``

Atom Packages

Markdown Related

  • atom-folding
  • folding-markdown
  • markdown-preview-enhanced
  • markdown-toc-auto

Not Markdown Related But Helpful

  • open-file
  • open-terminal-here
  • packages-txt by jgarber623
  • Sublime-Style-Column-Selection

Images

Local Image

![alt text if cannot show img](Image.png "Title on mouse hover")