https://github.com/kishan-aghera/redcarpet-gem-example
Demonstrates the use of redcarpet gem for markdown support in text with the help of coderay gem for syntax highlighting.
https://github.com/kishan-aghera/redcarpet-gem-example
coderay markdown-in-rails rails redcarpet-markdown-parser ruby ruby-on-rails
Last synced: about 2 months ago
JSON representation
Demonstrates the use of redcarpet gem for markdown support in text with the help of coderay gem for syntax highlighting.
- Host: GitHub
- URL: https://github.com/kishan-aghera/redcarpet-gem-example
- Owner: kishan-aghera
- Created: 2021-06-02T06:34:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-23T07:06:38.000Z (almost 5 years ago)
- Last Synced: 2025-12-19T22:29:42.666Z (6 months ago)
- Topics: coderay, markdown-in-rails, rails, redcarpet-markdown-parser, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 155 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/vmg/redcarpet) gem to make pages supporting markdown in ruby on rails framework. The [coderay](https://github.com/rubychan/coderay) gem is used to highlight the syntax of code snippet if present in the content. To upload media(images, videos and gifs) from your system, [Active Storage](https://guides.rubyonrails.org/active_storage_overview.html) is to be used in addition to these gems. Media already available on the web can be added in this app.
## 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.
```bash
# 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.
```bash
# 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.
```bash
$ rails s
```