Skip to content

Commit 7ea391b

Browse files
authored
Merge pull request #1283 from docsifyjs/master
Master
2 parents 0268594 + 05d650e commit 7ea391b

File tree

2 files changed

+63
-20
lines changed

2 files changed

+63
-20
lines changed

docs/index.html

+15-14
Original file line numberDiff line numberDiff line change
@@ -92,20 +92,21 @@
9292
}
9393
]
9494
}
95-
</script>
96-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
97-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
98-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/ga.min.js"></script>
99-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/matomo.min.js"></script>
100-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
101-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-markdown.min.js"></script>
102-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-nginx.min.js"></script>
103-
<script>
104-
((window.gitter = {}).chat = {}).options = {
105-
room: 'docsifyjs/Lobby'
106-
};
107-
</script>
108-
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
95+
</script>
96+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
97+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
98+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/ga.min.js"></script>
99+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/matomo.min.js"></script>
100+
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
101+
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-markdown.min.js"></script>
102+
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-nginx.min.js"></script>
103+
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-php.min.js"></script>
104+
<script>
105+
((window.gitter = {}).chat = {}).options = {
106+
room: 'docsifyjs/Lobby'
107+
};
108+
</script>
109+
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
109110
</body>
110111

111112
</html>

docs/language-highlight.md

+48-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,53 @@
1-
# language highlight
1+
# Language highlighting
22

3-
**docsify** uses [Prism](https://github.com/PrismJS/prism) to highlight code blocks in your pages. By default it only supports CSS, JavaScript and HTML. You can make **Prism** load additional languages:
3+
Docsify uses [Prism](https://prismjs.com) to highlight code blocks in your pages. Prism supports the following languages by default:
4+
5+
* Markup - `markup`, `html`, `xml`, `svg`, `mathml`, `ssml`, `atom`, `rss`
6+
* CSS - `css`
7+
* C-like - `clike`
8+
* JavaScript - `javascript`, `js`
9+
10+
Support for [additional languages](https://prismjs.com/#supported-languages) is available by loading the language-specific [grammar files](https://cdn.jsdelivr.net/npm/prismjs@1/components/) via CDN:
411

512
```html
6-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
7-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
8-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-php.min.js"></script>
13+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
14+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
915
```
1016

11-
?> Check the [component files](https://github.com/PrismJS/prism/tree/gh-pages/components) list for more options.
17+
To enable syntax highlighting, wrap each code block in triple backticks with the [language](https://prismjs.com/#supported-languages) specified on the first line:
18+
19+
````
20+
```html
21+
<p>This is a paragraph</p>
22+
<a href="//docsify.js.org/">Docsify</a>
23+
```
24+
25+
```bash
26+
echo "hello"
27+
```
28+
29+
```php
30+
function getAdder(int $x): int
31+
{
32+
return 123;
33+
}
34+
```
35+
````
36+
37+
The above markdown will be rendered as:
38+
39+
```html
40+
<p>This is a paragraph</p>
41+
<a href="//docsify.js.org/">Docsify</a>
42+
```
43+
44+
```bash
45+
echo "hello"
46+
```
47+
48+
```php
49+
function getAdder(int $x): int
50+
{
51+
return 123;
52+
}
53+
```

0 commit comments

Comments
 (0)