Using Markdown
This is a super trimmed down ✂️copy/🍝pasta version of vuepress - markdown extensions.
Elementary
## Heading 2
Paragraphs **bold** _italic_
### Unordered List
* house
* Cat
* Dog
* Monkey
* Fox
#### Ordered List
1. Last
1. least
1. First
1. Most
horizontal rule
---
##### Heading 5
> Blockquotes
⬇️
Heading 2
Paragraphs bold italic
Unordered List
- house
- Cat
- Dog
- Monkey
- Fox
Ordered List
- Last
- least
- First
- Most
horizontal rule
Heading 5
Blockquotes
Internal Links
[Home](/) <!-- Sends the user to the root README.md -->
[foo](/foo/) <!-- Sends the user to index.html of directory foo -->
[foo heading anchor](/foo/#heading) <!-- Anchors user to a heading in the foo README file -->
[foo - one](/foo/one.html) <!-- You can append .html -->
[foo - two](/foo/two.md) <!-- Or you can append .md -->
⬇️
External Links
Outbound links automatically gets target="_blank" rel="noopener noreferrer"
:
[name](/link)
⬇️
Images
#### Internal Image

#### External Image

⬇️
Internal Image
External Image
GitHub-Style Tables
| name | role | phrase | spirit-animal | hp |
| ----- | ------ | --------- |:-------------:| --- |
| John | Wizard | "Yeah" | Cat | 200 |
| Sally | Knight | "Woot" | Dragon | 700 |
| Carl | Rogue | "Tsk Tsk" | Caterpillar | 150 |
| Maria | Healer | "Meh" | Tiger | 400 |
⬇️
name | role | phrase | spirit-animal | hp |
---|---|---|---|---|
John | Wizard | "Yeah" | Cat | 200 |
Sally | Knight | "Woot" | Dragon | 700 |
Carl | Rogue | "Tsk Tsk" | Caterpillar | 150 |
Maria | Healer | "Meh" | Tiger | 400 |
Emoji
:tada:
:heart:
⬇️
🎉
❤️
Table of Contents
[[toc]]
⬇️
Custom Containers
::: tip
This is a tip
:::
::: warning
This is a warning
:::
::: danger
This is a dangerous warning
:::
⬇️
TIP
This is a tip
WARNING
This is a warning
WARNING
This is a dangerous warning
Line Highlight Codeblocks
js{4}
export default {
data () {
return {
msg: 'Highlighted! Line 4'
}
}
}
⬇️
export default {
data () {
return {
msg: 'Highlighted! Line 4'
}
}
}
File path
<<< @/help/markdown/README.md <!-- this file -->
⬇️
Not found: /Users/andycj/Github/PressVue/help/markdown/README.md
Markdown Config
markdown: {
// settings go here
}
TOC
// options for markdown-it-toc
toc: { includeLevel: [1, 2, 3, 4] }
lineNumbers
// Line Numbers
lineNumbers: true,
Anchors
// options for markdown-it-anchor
anchor: {
permalink: true, // Whether to add permalinks next to titles.
permalinkBefore: true,
permalinkSymbol: '#'
}
markdown-it
config: md => {
md.set({
breaks: true, // Convert '\n' in paragraphs into <br>
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />).
// This is only for full CommonMark compatibility.
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks. Can be
// useful for external highlighters.
linkify: false, // Autoconvert URL-like text to links
}),
md.use(require('markdown-it-highlightjs')),
md.use(require('markdown-it-prism'), { 'plugins': ['copy-to-clipboard'] })
}