From 1daf2f788ae5423384ea2b9e1688c3fa1c156b1f Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Sat, 14 May 2022 20:55:55 +0200 Subject: [PATCH 1/4] Add mention of `starry-night` to readme Closes GH-101. --- readme.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index c41f991..93e1b88 100644 --- a/readme.md +++ b/readme.md @@ -44,7 +44,9 @@ 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 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: From 69b792614f2cbe17da8dfa1429c9c37edc5b13ad Mon Sep 17 00:00:00 2001 From: Titus Date: Sun, 15 May 2022 19:03:48 +0200 Subject: [PATCH 2/4] Update readme.md Co-authored-by: Sindre Sorhus --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 93e1b88..3afc608 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 ``` -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. +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 . From 4afc58ae968eb2c6ef3476e7e6f70de8b45e6859 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Sun, 15 May 2022 19:05:10 +0200 Subject: [PATCH 3/4] Remove stray sentence --- readme.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/readme.md b/readme.md index 3afc608..f579673 100644 --- a/readme.md +++ b/readme.md @@ -46,8 +46,6 @@ Import the `github-markdown.css` file and add a `markdown-body` class to the con 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: - **github-markdown.css**: (default) Automatically switches between light and dark through [`@media (prefers-color-scheme)`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme). From 015aa17072e9b2aef12ec7ae71cd5bed70e8cb17 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Mon, 16 May 2022 00:18:07 +0700 Subject: [PATCH 4/4] Update readme.md --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index f579673..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 ``` -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. +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: