Skip to content

Commit 667bd32

Browse files
committed
Updated docs
1 parent df9bf05 commit 667bd32

File tree

3 files changed

+120
-3
lines changed

3 files changed

+120
-3
lines changed

README.md

Lines changed: 118 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,52 @@
11
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
22

33

4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
420
# showdown-highlight
521

622
[![Version](https://img.shields.io/npm/v/showdown-highlight.svg)](https://www.npmjs.com/package/showdown-highlight) [![Downloads](https://img.shields.io/npm/dt/showdown-highlight.svg)](https://www.npmjs.com/package/showdown-highlight)
723

24+
25+
26+
27+
28+
29+
830
> A Showdown extension for highlight the code blocks.
931
32+
33+
34+
35+
36+
1037
This package uses [`highlight.js`](https://highlightjs.org) to highlight code blocks in [Showdown](https://github.com/showdownjs/showdown) output. :rocket:
1138

39+
40+
41+
42+
43+
44+
45+
46+
47+
48+
49+
1250
## :cloud: Installation
1351

1452
```sh
@@ -20,6 +58,17 @@ yarn add showdown-highlight
2058
```
2159

2260

61+
62+
63+
64+
65+
66+
67+
68+
69+
70+
71+
2372
## :clipboard: Example
2473

2574

@@ -65,26 +114,94 @@ console.log(html);
65114

66115

67116

117+
118+
119+
120+
121+
122+
68123
## :question: Get Help
69124

70125
There are few ways to get help:
71126

127+
128+
72129
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
73130
2. For bug reports and feature requests, open issues. :bug:
74131

75132

76133

77134

135+
136+
137+
138+
139+
140+
141+
142+
143+
144+
145+
146+
78147
## :yum: How to contribute
79148
Have an idea? Found a bug? See [how to contribute][contributing].
80149

81150

82151

152+
153+
154+
155+
156+
157+
158+
159+
160+
161+
162+
163+
164+
165+
## :dizzy: Where is this library used?
166+
If you are using this library in one of your projects, add it in this list. :sparkles:
167+
168+
- `mdpdf`
169+
- `bloggify-markdown-highlight`
170+
- `@kev_nz/publisher`
171+
- `md-toy-blog`
172+
- `markdown2dash`
173+
- `ember-showdown-highlight`
174+
- `trumpdoc`
175+
- `md-srv`
176+
- `md-browse`
177+
- `showit`
178+
- `chimpsky`
179+
- `showdown-html`
180+
- `callete`
181+
- `swanky`
182+
- `tutors-html`
183+
- `@etermind/alex`
184+
185+
186+
187+
188+
189+
190+
191+
192+
193+
194+
83195
## :scroll: License
84196

85197
[MIT][license] © [Bloggify][website]
86198

87-
[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2016#license-mit
199+
200+
201+
202+
203+
204+
[license]: /LICENSE
88205
[website]: https://bloggify.org
89206
[contributing]: /CONTRIBUTING.md
90207
[docs]: /DOCUMENTATION.md

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@
5454
"obedm503 (https://obedm503.github.io)",
5555
"Ariel Shaqed (Scolnicov) (https://github.com/arielshaqed)"
5656
]
57-
}
57+
}

0 commit comments

Comments
 (0)