-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1283 from docsifyjs/master
Master
- Loading branch information
Showing
2 changed files
with
63 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,53 @@ | ||
# language highlight | ||
# Language highlighting | ||
|
||
**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: | ||
Docsify uses [Prism](https://prismjs.com) to highlight code blocks in your pages. Prism supports the following languages by default: | ||
|
||
* Markup - `markup`, `html`, `xml`, `svg`, `mathml`, `ssml`, `atom`, `rss` | ||
* CSS - `css` | ||
* C-like - `clike` | ||
* JavaScript - `javascript`, `js` | ||
|
||
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: | ||
|
||
```html | ||
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script> | ||
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script> | ||
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-php.min.js"></script> | ||
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script> | ||
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script> | ||
``` | ||
|
||
?> Check the [component files](https://github.com/PrismJS/prism/tree/gh-pages/components) list for more options. | ||
To enable syntax highlighting, wrap each code block in triple backticks with the [language](https://prismjs.com/#supported-languages) specified on the first line: | ||
|
||
```` | ||
```html | ||
<p>This is a paragraph</p> | ||
<a href="//docsify.js.org/">Docsify</a> | ||
``` | ||
```bash | ||
echo "hello" | ||
``` | ||
```php | ||
function getAdder(int $x): int | ||
{ | ||
return 123; | ||
} | ||
``` | ||
```` | ||
|
||
The above markdown will be rendered as: | ||
|
||
```html | ||
<p>This is a paragraph</p> | ||
<a href="//docsify.js.org/">Docsify</a> | ||
``` | ||
|
||
```bash | ||
echo "hello" | ||
``` | ||
|
||
```php | ||
function getAdder(int $x): int | ||
{ | ||
return 123; | ||
} | ||
``` |
7ea391b
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to following URLs: