StarMirror/github-markdown-css
1
0
Fork 0
mirror of https://github.com/sindresorhus/github-markdown-css.git synced 2024-03-22 13:10:53 +08:00
Code Issues Projects Releases Wiki Activity

Add mention of starry-night to readme

Browse Source 
Closes GH-101.
This commit is contained in:
Titus Wormer 2022-05-14 20:55:55 +02:00
parent afa572390d
commit 1daf2f788a
No known key found for this signature in database
GPG Key ID: E6E581152ED04E2E
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
readme.md
View File

@ -44,7 +44,9 @@ Import the `github-markdown.css` file and add a `markdown-body` class to the con
</article>
```
If you want code syntax highlighted, use GitHub Flavored Markdown rendered from [GitHub's `/markdown` API](https://docs.github.com/en/free-pro-team@latest/rest/reference/markdown).
You can use [GitHub's `/markdown` API](https://docs.github.com/en/free-pro-team@latest/rest/reference/markdown) to turn markdown into the HTML that GitHub generates, which works well with the CSS generated here. Other markdown parsers will mostly work with these styles too. To mimic how GitHub highlights code, you can use [`starry-night`](https://github.com/wooorm/starry-night) with your markdown parser of choice.
If you want code syntax highlighted, use GitHub Flavored Markdown rendered from .
There are 3 themes provided in this package: