Skip to content

Commit a9183a3

Browse files
files added
0 parents  commit a9183a3

File tree

10 files changed

+383
-0
lines changed

10 files changed

+383
-0
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Change Log
2+
3+
All notable changes to the "mdsnippets" extension will be documented in this file.
4+
5+
6+
## [MDsnippets 1.0.0]
7+
8+
- Initial release

README.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
![settings](https://user-images.githubusercontent.com/64256342/107140348-584d7d80-6947-11eb-8039-b346614e7151.png)
2+
# MDsnippets README
3+
4+
Editing Markdown files made easy with a single click.
5+
6+
## Features
7+
8+
Mdsnippets gives you a large variety of snippets for editing Markdown files (.md files).Remembering a large amount of Markdown syntax is a tiresome thing.
9+
10+
**Well we got you covered !**
11+
12+
With MDsnippets , you have the power of editing and creating Markdown files in a great speed and flow.
13+
(and to mention without any **typos** !)
14+
15+
> MDsnippets gives you a upper hand at creating catchy Readme,and even more.
16+
17+
18+
---------------------------------------------------------------------------------------------------------
19+
20+
## Extension Settings
21+
22+
MDsnippets use **Tab completion** feature.
23+
To enable Tab completion feature,
24+
25+
1. `File -> preferences -> settings`(or) `Ctrl+,`
26+
![settings](https://user-images.githubusercontent.com/64256342/107140350-5aafd780-6947-11eb-9b78-35bad121b5e6.png)
27+
28+
2. inside `settings` search for **Tab completion** and enable it if it is disabled by default.
29+
![settings](https://user-images.githubusercontent.com/64256342/107140357-60a5b880-6947-11eb-8633-31a6ffb7ec8d.png)
30+
31+
3. You can also use ``"editor.tabCompletion": "on"`` in search bar of settings to enable it.
32+
33+
4. Done !
34+
-----------------------------------------------------------------------------------------------------------
35+
36+
## Working with MDsnippets
37+
38+
**Note:** Tab Completion feature is **``mandatory``** for MDsnippets to work.
39+
40+
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
41+
* Press `tab` after typing the trigger word.
42+
----------------------------------------------------------------------------------------------------------
43+
| Trigger word | Function |
44+
| ------------- |:-------------:|
45+
| !h1 |Creates a heading 1 |
46+
| !h2 | Creates a heading 2 |
47+
| !h3 | Creates a heading 3|
48+
| !h4 |Creates a heading 4 |
49+
| !h5 | Creates a heading 5 |
50+
| !h6 | Creates a heading 6|
51+
| !it |Creates a italics text |
52+
| !b | Creates a bold text |
53+
| !ol | Creates a ordered list|
54+
| !ul |Creates a unordered list |
55+
| !lnkt | Creates a link with title|
56+
| !mailto |Creates a mailto link for easy mailing |
57+
| !imghov | Creates a image with title on hover |
58+
| !cs | Creates a single line code|
59+
| !cb |Creates a code block |
60+
| !t12 | Creates a 1X2 table |
61+
| !t13 | Creates a 1X3 table |
62+
| !t21 | Creates a 2X1 table |
63+
| !t22 | Creates a 2X2 table |
64+
| !t23 | Creates a 2X3 table |
65+
| !t31 | Creates a 3X1 table |
66+
| !t32 | Creates a 3X2 table |
67+
| !t33 | Creates a 3X3 table |
68+
| !bq | Creates a blockquote |
69+
| !hl | Creates a horizontal line seperator |
70+
**OTHER TRIGGER WORDS**
71+
| !strike | Creates a strikethrough text |
72+
| !m | Creates a mention |
73+
| !cic | Creates a checklist item (checked) |
74+
| !ciu | Creates a checklist item(unchecked) |
75+
76+
77+
78+
### For more information
79+
80+
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
81+
* [Ping me on GitHub](https://github.com/code-reaper08)
82+
83+
**Easy Editing !**

icon.png

6.26 KB
Loading

launch.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// A launch configuration that launches the extension inside a new window
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
{
6+
"version": "0.2.0",
7+
"configurations": [
8+
{
9+
"name": "Extension",
10+
"type": "extensionHost",
11+
"request": "launch",
12+
"args": [
13+
"--extensionDevelopmentPath=${workspaceFolder}"
14+
]
15+
}
16+
]
17+
}

mdsnippets-1.0.0.vsix

186 KB
Binary file not shown.

package.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"name": "mdsnippets",
3+
"displayName": "MDsnippets",
4+
"description": "Get super simple snippets for your .md (MarkDown) files.",
5+
"version": "1.0.0",
6+
"repository": {
7+
"type": "git",
8+
"url": "https://github.com/code-reaper08/MDsnippets"
9+
},
10+
"publisher": "VishwaR",
11+
"icon": "icon.png",
12+
"galleryBanner": {
13+
"color": "#C80000",
14+
"theme": "dark"
15+
},
16+
"engines": {
17+
"vscode": "^1.52.0"
18+
},
19+
"categories": [
20+
"Snippets"
21+
],
22+
"keywords": [
23+
"Markdown",
24+
".md files",
25+
"Easy",
26+
"Snippets",
27+
"code",
28+
"Mdsnippets",
29+
"All"
30+
],
31+
"contributes": {
32+
"snippets": [
33+
{
34+
"language": "markdown",
35+
"path": "./snippets/snippets.code-snippets"
36+
}
37+
]
38+
}
39+
}

settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"editor.tabCompletion": "on"
3+
}

settings.png

77 KB
Loading

snippets/snippets.code-snippets

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,233 @@
1+
{
2+
"Heading 1":{
3+
"prefix": "!h1",
4+
"body": [
5+
"# ${1:Content}"
6+
],
7+
"description": "Creates a H1 heading"
8+
},
9+
"Heading 2":{
10+
"prefix": "!h2",
11+
"body": [
12+
"## ${1:Content}"
13+
],
14+
"description": "Creates a H2 heading"
15+
},
16+
"Heading 3":{
17+
"prefix": "!h3",
18+
"body": [
19+
"### ${1:Content}"
20+
],
21+
"description": "Creates a H3 heading"
22+
},
23+
"Heading 4":{
24+
"prefix": "!h4",
25+
"body": [
26+
"#### ${1:Content}"
27+
],
28+
"description": "Creates a H4 heading"
29+
},
30+
"Heading 5":{
31+
"prefix": "!h5",
32+
"body": [
33+
"##### ${1:Content}"
34+
],
35+
"description": "Creates a H5 heading"
36+
},
37+
"Heading 6":{
38+
"prefix": "!h6",
39+
"body": [
40+
"###### ${1:Content}"
41+
],
42+
"description": "Creates a H6 heading"
43+
},
44+
"Italics":{
45+
"prefix": "!it",
46+
"body": [
47+
"_${1:italic text}_"
48+
],
49+
"description": "Creates a italic text"
50+
},
51+
"Bold":{
52+
"prefix": "!b",
53+
"body": [
54+
"**${1:BOLD text here}**"
55+
],
56+
"description": "Creates a bold text"
57+
},
58+
"Ordered List":{
59+
"prefix": "!ol",
60+
"body": [
61+
"1. ${1:item1}",
62+
"2. ${2:item2}",
63+
"3. ${3:item3}"
64+
],
65+
"description": "Creates a ordered list"
66+
},
67+
"Unordered List":{
68+
"prefix": "!ul",
69+
"body": [
70+
"+ ${1:item1}",
71+
"+ ${2:item2}",
72+
"+ ${3:item3}"
73+
],
74+
"description": "Creates a Unordered list"
75+
},
76+
"Link with Title":{
77+
"prefix": "!lnkt",
78+
"body": [
79+
"[${1:Title}](${2:Link})"
80+
],
81+
"description": "Creates a link with title"
82+
},
83+
"Mailto":{
84+
"prefix": "!mailto",
85+
"body": [
86+
"[${1:Clickable Display Text}](mailto:${2:email address here}?subject=[${3:subject here}]%20Source%20Han%20Sans)"
87+
],
88+
"description": "Creates a mailto link for easy mailing scenarios"
89+
},
90+
"Image with title on hover":{
91+
"prefix": "!imghov",
92+
"body": [
93+
"![${1:alt text}](${2:Image link} \"${3:Hover Text}\")"
94+
],
95+
"description": "Creates a image with a hover text"
96+
},
97+
"single line code":{
98+
"prefix": "!cs",
99+
"body": [
100+
"`${1:Code here}`"
101+
],
102+
"description": "Creates a single line code(inline)"
103+
},
104+
"Block of code":{
105+
"prefix": "!cb",
106+
"body": [
107+
"```${1:Language}",
108+
"$0",
109+
"```"
110+
],
111+
"description": "Creates a Code Block"
112+
},
113+
"Table 1X2":{
114+
"prefix": "!t12",
115+
"body": [
116+
"| ${1:1,1} | ${2: 1,2} |",
117+
"| ------------- |:-------------:|"
118+
],
119+
"description": "creates a 1X2 table"
120+
},
121+
"Table 1X3":{
122+
"prefix": "!t13",
123+
"body": [
124+
"| ${1:1,1} | ${2:1,2} | ${3:1,3} |",
125+
"| ------------- |:-------------:| -----:|",
126+
],
127+
"description": "Craetes a 1X3 table"
128+
},
129+
"Table 2X1":{
130+
"prefix": "!t21",
131+
"body": [
132+
"| ${1:1,1} |",
133+
"| ------------- |",
134+
"| ${2:2,1} ||"
135+
],
136+
"description": "creates a 2X1 table"
137+
},
138+
"Table 2X2":{
139+
"prefix": "!t22",
140+
"body": [
141+
"| ${1:1,1} | ${2: 1,2} |",
142+
"| ------------- |:-------------:|",
143+
"| ${3:2,1} | ${4:2,2} |"
144+
],
145+
"description": "creates a 2X2 table"
146+
},
147+
"Table 2X3":{
148+
"prefix": "!t23",
149+
"body": [
150+
"| ${1:1,1} | ${2:1,2} | ${3:1,3} |",
151+
"| ------------- |:-------------:| -----:|",
152+
"| ${4:2,1} |${5:2,2} | ${6:2,3} |"
153+
154+
],
155+
"description": "Creates a 2X3 table"
156+
},
157+
"Table 3X1":{
158+
"prefix": "!t31",
159+
"body": [
160+
"| ${1:1,1} |",
161+
"| ------------- |",
162+
"| ${4:2,1} |",
163+
"| ${7:3,1} |"
164+
],
165+
"description": "Craetes a 3X1 table"
166+
},
167+
"Table 3X2":{
168+
"prefix": "!t32",
169+
"body": [
170+
"| ${1:1,1} | ${2:1,2} |",
171+
"| ------------- |:-------------:|",
172+
"| ${4:2,1} |${5:2,2} |",
173+
"| ${7:3,1} | ${8:3,2} |"
174+
],
175+
"description": "Craetes a 3X2 table"
176+
},
177+
"Table 3X3":{
178+
"prefix": "!t33",
179+
"body": [
180+
"| ${1:1,1} | ${2:1,2} | ${3:1,3} |",
181+
"| ------------- |:-------------:| -----:|",
182+
"| ${4:2,1} |${5:2,2} | ${6:2,3} |",
183+
"| ${7:3,1} | ${8:3,2} | ${9:3,3} |"
184+
],
185+
"description": "Craetes a 3X3 table"
186+
},
187+
188+
"blockquotes":{
189+
"prefix": "!bq",
190+
"body": [
191+
"> ${1:Text here}"
192+
],
193+
"description": "Creates a blockquote"
194+
},
195+
"Horizontal Line":{
196+
"prefix": "!hl",
197+
"body": [
198+
"---"
199+
],
200+
"description": "Inserts a horizontal line seperator"
201+
},
202+
"Strikethrough":{
203+
"prefix": "!strike",
204+
"body": [
205+
"~~${1:Text here}~~"
206+
],
207+
"description": "Creates a strikethrough text"
208+
},
209+
210+
//github specific markdown snippets
211+
212+
"mention":{
213+
"prefix": "!m",
214+
"body": [
215+
"@${1:Username}"
216+
],
217+
"description": "Creates a mention "
218+
},
219+
"Checklist item (Checked)":{
220+
"prefix": "!cic",
221+
"body": [
222+
"- [x] ${1:Checked item}"
223+
],
224+
"description": "Creates a checked item"
225+
},
226+
"Checklist item (UnChecked)":{
227+
"prefix": "!ciu",
228+
"body": [
229+
"- [ ] ${1:Unchecked item}"
230+
],
231+
"description": "Creates a Unchecked item"
232+
}
233+
}

tab.png

117 KB
Loading

0 commit comments

Comments
 (0)