Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wlwl2/markdown-language-notes
Notes on the markdown language used in Github
https://github.com/wlwl2/markdown-language-notes
info markdown string
Last synced: about 2 months ago
JSON representation
Notes on the markdown language used in Github
- Host: GitHub
- URL: https://github.com/wlwl2/markdown-language-notes
- Owner: wlwl2
- Created: 2016-04-24T14:38:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T01:59:38.000Z (about 1 year ago)
- Last Synced: 2024-04-16T14:21:40.089Z (8 months ago)
- Topics: info, markdown, string
- Language: HTML
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](#links)
- [To The Same Document](#to-the-same-document)
- [Inline Links](#inline-links)
- [Relative links](#relative-links)
- [Raw URLs](#raw-urls)
- [Footnotes](#footnotes)
- [Info Strings](#info-strings)
- [GitHub Flavored Markdown Spec](#github-flavored-markdown-spec)
- [Code fences](#code-fences)
- [Double Backticks](#double-backticks)
- [Atom Packages](#atom-packages)
- [Markdown Related](#markdown-related)
- [Not Markdown Related But Helpful](#not-markdown-related-but-helpful)
- [Images](#images)
- [Local Image](#local-image)
## 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.
```markdown
[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
```markdown
[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:
```markdown
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
```
[Relative links example](docs/relative-links-example.md)
[Source](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links)
### Raw URLs
URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com or 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?
```markdown
Here is a simple footnote[^1]. With some additional text after it.
[^1]: My reference.
```
## Info Strings
[docs/info-strings.md](docs/info-strings.md) Contains a list of info strings
for code fences.
## GitHub Flavored Markdown Spec
[https://github.github.com/gfm/](https://github.github.com/gfm/)
## Code fences
Code fences look like this:
````markdown
```
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
````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:
```markdown
``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:
```markdown
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](https://github.com/jgarber623/packages-txt) by *jgarber623*
- Sublime-Style-Column-Selection
## Images
### Local Image
``