Skip to content
This repository has been archived by the owner on Mar 4, 2024. It is now read-only.

Commit

Permalink
Add demo to readme and other improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushn21 committed Jun 1, 2021
1 parent 265d834 commit 9b2ca2d
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

`actiontext-syntax-highlighter` is an extension for `rails/actiontext` to allow the user to add language specified code blocks that are then highlighted on the server using [Rouge](http://github.com/rouge-ruby/rouge).

**Check out the demo app to see how it works!**
[**Check out the demo app to see how it works!**](https://actiontext-syntax-highlighter.herokuapp.com).

> Note: The experience is a bit flaky, especially on Safari. If you have any suggestions for how to improve it, please file an issue; or even better, open a Pull Request!
Expand All @@ -14,13 +14,20 @@ The changes to the code block are saved to the server every time edits are made.


## Installation
Add this line to your application's Gemfile:

Install ActionText if you haven't already done so:

```shell
$ bin/rails action_text:install
```

Then add this gem to your application's Gemfile:

```ruby
gem 'actiontext-syntax-highlighter', require: 'action_text_syntax_highlighter/engine'
```

And then execute:
And bundle and install it:

```bash
$ bundle
Expand Down

0 comments on commit 9b2ca2d

Please sign in to comment.