Skip to content

Commit 251423d

Browse files
authored
Update various doc (rouge-ruby#2086)
* Fix typo and trim spaces * Use bash syntax for all shell scripts * Update CI badge link
1 parent b99ce25 commit 251423d

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

LICENSE

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2121
THE SOFTWARE.
2222

2323
# SPECIAL NOTE:
24+
2425
Many of the lexers in this project are adaptations of those in Pygments
25-
(pygments.org). The license for Pygments is as follows:
26+
(pygments.org). The license for Pygments is as follows:
2627

2728
# BEGIN pygments/LICENSE #
2829

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Rouge
22

3-
![Build Status](https://github.com/rouge-ruby/rouge/actions/workflows/ruby.yml/badge.svg)
3+
[![Build Status](https://github.com/rouge-ruby/rouge/actions/workflows/ruby.yml/badge.svg)](https://github.com/rouge-ruby/rouge/actions/workflows/ruby.yml)
44
[![Gem Version](https://badge.fury.io/rb/rouge.svg)](https://rubygems.org/gems/rouge)
55
[![YARD Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rouge-ruby.github.io/docs/)
66

@@ -23,7 +23,7 @@ gem 'rouge'
2323

2424
or
2525

26-
```sh
26+
```bash
2727
gem install rouge
2828
```
2929

@@ -67,7 +67,7 @@ use and whether to enable line numbers or not. More information is available in
6767
Rouge ships with a `rougify` command which allows you to easily highlight files
6868
in your terminal:
6969

70-
```sh
70+
```bash
7171
rougify foo.rb
7272
rougify style monokai.sublime > syntax.css
7373
```
@@ -278,7 +278,7 @@ test file by setting the `TEST` environment variable to the path of the desired
278278
test. For example, to test just the _`ruby` lexer_ (located at path
279279
`spec/lexers/ruby_spec.rb`) simply run the following:
280280

281-
```sh
281+
```bash
282282
TEST=spec/lexers/ruby_spec.rb rake
283283
```
284284

docs/DevEnvironment.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ fork. Select your account and—boom!—you've just forked Rouge.
7070
The next thing to do is to get your fork onto your computer. Git makes this
7171
easy. In the directory you want to hold your repository, type:
7272

73-
```shell
73+
```bash
7474
git clone [email protected]:<your_github_account_name>/rouge.git
7575
```
7676

@@ -87,7 +87,7 @@ of time developing Rouge, this is something you'll want to do.
8787
Fortunately, it's easy to add additional remote repositories. To add the
8888
official Rouge repository (with the name `upstream`), type the following:
8989

90-
```shell
90+
```bash
9191
git remote add upstream https://github.com/rouge-ruby/rouge.git
9292
```
9393

@@ -116,7 +116,7 @@ If you already develop with Ruby, you no doubt have Bundler installed. You can
116116
check if you do by typing `bundle -v` at the command line. If you don't see the
117117
version number then you need to install Bundler. To do this, type:
118118

119-
```shell
119+
```bash
120120
gem install bundler
121121
```
122122

@@ -128,7 +128,7 @@ that's complete, you're ready to rock.
128128
Rouge comes with a list of gems it depends upon called a _Gemfile_. Make sure
129129
you're at the top level of your clone of your repository and type:
130130

131-
```shell
131+
```bash
132132
bundle config set path 'vendor'
133133
bundle install
134134
```
@@ -149,7 +149,7 @@ type `bundle exec rake` rather than just `rake`.
149149

150150
It's best to develop in a _branch_. You can create a branch by typing:
151151

152-
```shell
152+
```bash
153153
git checkout -b <name_of_your_branch>
154154
```
155155

docs/LexerDevelopment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ that there is no file extension.
473473

474474
### Visual Samples
475475

476-
A visual sample is a file that includes a representive sample of the syntax of
476+
A visual sample is a file that includes a representative sample of the syntax of
477477
your language. The sample should be long enough to reasonably demonstrate the
478478
correct lexing of the language but does not need to offer complete coverage.
479479
While it can be tempting to copy and paste code found online, please refrain

0 commit comments

Comments
 (0)