Skip to content

Commit d96ef7c

Browse files
committed
[docs] clean up README
1 parent e150dba commit d96ef7c

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Middleman-Syntax
22

3-
`middleman-syntax` is an extension for the [Middleman] static site generator that adds syntax highlighting via [Rouge](https://github.com/jayferd/rouge).
3+
`middleman-syntax` is an extension for the [Middleman](https://middlemanapp.com) static site generator that adds syntax highlighting via [Rouge](https://github.com/jayferd/rouge).
44

5-
[![Gem Version](https://badge.fury.io/rb/middleman-syntax.svg)][gem]
5+
[![Gem Version](https://badge.fury.io/rb/middleman-syntax.svg)](https://rubygems.org/gems/middleman-syntax)
66
[![CI](https://github.com/middleman/middleman-syntax/actions/workflows/ci.yml/badge.svg)](https://github.com/middleman/middleman-syntax/actions/workflows/ci.yml)
7-
[![Code Quality](https://codeclimate.com/github/middleman/middleman-syntax.svg)][codeclimate]
7+
[![Maintainability](https://qlty.sh/gh/middleman/projects/middleman-syntax/maintainability.svg)](https://qlty.sh/gh/middleman/projects/middleman-syntax)
88

99
## Installation
1010

@@ -59,7 +59,7 @@ end
5959
<% end %>
6060
```
6161

62-
*Note:* In Haml, use `=`, not `-`:
62+
**NOTE:** In Haml, use `=`, not `-`:
6363

6464
```haml
6565
= code('ruby') do
@@ -105,6 +105,7 @@ end
105105
```
106106

107107
This will produce HTML like:
108+
108109
```html
109110
<div class="highlight"><pre class="highlight ruby custom-class special"><code>...</code></pre></div>
110111
```
@@ -125,7 +126,7 @@ And then include it in your layout or specific page by:
125126
<%= stylesheet_link_tag "highlighting" %>
126127
```
127128

128-
If you want to include this in a larger Sass stylesheet, include it in your main stylesheet with `@import 'highlighting.css'`).
129+
If you want to include this in a larger Sass stylesheet, include it in your main stylesheet with `@import 'highlighting.css'`.
129130

130131
Rouge has `ThankfulEyes`, `Colorful`, `Github`, `Base16`, `Base16::Solarized`, `Base16::Monokai`, and `Monokai` themes.
131132

@@ -232,9 +233,4 @@ The best way to get quick responses to your issues and swift fixes to your bugs
232233

233234
## License
234235

235-
Copyright (c) 2012-2014 Benjamin Hollis. MIT Licensed, see [LICENSE] for details.
236-
237-
[middleman]: http://middlemanapp.com
238-
[gem]: https://rubygems.org/gems/middleman-syntax
239-
[codeclimate]: https://codeclimate.com/github/middleman/middleman-syntax
240-
[LICENSE]: https://github.com/middleman/middleman-syntax/blob/master/LICENSE.md
236+
Copyright (c) 2012-2014 Benjamin Hollis. MIT Licensed, see [LICENSE](LICENSE.md) for details.

0 commit comments

Comments
 (0)