Skip to content

Commit

Permalink
Update various doc (#2086)
Browse files Browse the repository at this point in the history
* Fix typo and trim spaces

* Use bash syntax for all shell scripts

* Update CI badge link
  • Loading branch information
tancnle authored Nov 12, 2024
1 parent b99ce25 commit 251423d
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

# SPECIAL NOTE:

Many of the lexers in this project are adaptations of those in Pygments
(pygments.org). The license for Pygments is as follows:
(pygments.org). The license for Pygments is as follows:

# BEGIN pygments/LICENSE #

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rouge

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

Expand All @@ -23,7 +23,7 @@ gem 'rouge'

or

```sh
```bash
gem install rouge
```

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

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

```sh
```bash
TEST=spec/lexers/ruby_spec.rb rake
```

Expand Down
10 changes: 5 additions & 5 deletions docs/DevEnvironment.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ fork. Select your account and—boom!—you've just forked Rouge.
The next thing to do is to get your fork onto your computer. Git makes this
easy. In the directory you want to hold your repository, type:

```shell
```bash
git clone [email protected]:<your_github_account_name>/rouge.git
```

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

```shell
```bash
git remote add upstream https://github.com/rouge-ruby/rouge.git
```

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

```shell
```bash
gem install bundler
```

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

```shell
```bash
bundle config set path 'vendor'
bundle install
```
Expand All @@ -149,7 +149,7 @@ type `bundle exec rake` rather than just `rake`.

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

```shell
```bash
git checkout -b <name_of_your_branch>
```

Expand Down
2 changes: 1 addition & 1 deletion docs/LexerDevelopment.md
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ that there is no file extension.

### Visual Samples

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

0 comments on commit 251423d

Please sign in to comment.