ReadMe file for redcarpet implementation repository

README.md

Redcarpet Gem Example

Demonstrates the use of redcarpet gem for markdown support in text with the help of coderay gem for syntax highlighting.

Description

The project have been implemented to demonstrate how we can use redcarpet gem to make pages supporting markdown in ruby on rails framework.

Install

To setup project locally, follow below instructions.

Project Configuration

Have ruby version ruby-2.7.2 installed as mentioned in Gemfile.

Install necessary dependencies.

# install dependencies mentioned in Gemfile
$ bundle install

# verification of already installed files in node_modules
$ yarn install --check-files

Database Setup

Create and Initialize database.

# migration of database
$ rails db:migrate

Starting the server

To start the server on localhost run the command below. The server will start on default port 3000.

$ rails s

"Demonstrates the use of redcarpet gem for markdown support in text with the help of coderay gem for syntax highlighting." How about this?

Sounds great!

I'll have it on the revision, and let me know it's good or not!