From 9719250aca854ff73070da6c64a579b610773cb3 Mon Sep 17 00:00:00 2001 From: Titus Date: Sun, 15 May 2022 19:19:35 +0200 Subject: [PATCH] Add mention of `starry-night` to readme (#102) --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index c41f991..9bd2994 100644 --- a/readme.md +++ b/readme.md @@ -44,7 +44,7 @@ Import the `github-markdown.css` file and add a `markdown-body` class to the con ``` -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 in this repo. 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. There are 3 themes provided in this package: