Edit Markdown in Ruby SDK

Use REST API to edit Markdown in Ruby programmatically

When developers modify a Markdown document with this Ruby library, what is actually being edited is the Document Object Model (DOM). Thus, almost any changes can be made to the Markdown document represented as DOM. With the provided Ruby SDK, developers can easily edit a document: modify text, update tables, add images and so on. Just load a Markdown, make the necessary changes programmatically and export the result to the same or any supported save format.

View code snippet

Edit Markdown in Ruby using REST API

Our Ruby library gives developers the ability to modify a Markdown document directly by editing its Document Object Model (DOM), which means no additional software needs to be installed.

Edit text in Markdown file using Ruby

The most popular case to edit a Markdown file is text editing. With the given software solution, you can add, modify or delete text using Ruby within the document.

Edit table in Markdown file using Ruby

Another popular Markdown editing option is table editing. Our Ruby SDK allows you to work with tables and text in table cells.

Ruby developers can add or remove table and table cells, as well as add, edit and remove text within them.

Add an image to Markdown file using Ruby

Besides editing text and tables in Markdown, there is another common option: adding images to a document in Ruby. Ruby developers can also add an image into a Markdown file using DOM.

Edit Markdown programmatically

Try this powerful Ruby SDK and evaluate some options in Markdown document editing. Using the following example, load your Markdown document and make some changes: add text, add a table and a table cell with text or insert an image into the Markdown document:

Upload a document you want to modify
Run code
Upload an image you want insert
Select the target format from the list
require 'aspose_words_cloud'

AsposeWordsCloud.configure do |config|
  config.client_data['ClientId'] = '####-####-####-####-####'
  config.client_data['ClientSecret'] = '##################'
end
@words_api = WordsAPI.new

request_document = File.open('Input.md')
request_paragraph = ParagraphInsert.new({:Text => 'Morbi enim nunc faucibus a.'})
insert_paragraph_request = InsertParagraphOnlineRequest.new(document: request_document, 
   paragraph: request_paragraph)
insert_paragraph = @words_api.insert_paragraph_online(insert_paragraph_request)

convert_request = ConvertDocumentRequest.new(
   document: insert_paragraph.document.values[0], format: 'md')
convert = @words_api.convert_document(convert_request)
require 'aspose_words_cloud'

AsposeWordsCloud.configure do |config|
  config.client_data['ClientId'] = '####-####-####-####-####'
  config.client_data['ClientSecret'] = '##################'
end
@words_api = WordsAPI.new

request_document = File.open('Input.md')
request_table = TableInsert.new({:ColumnsCount => 1, :RowsCount => 2})
insert_table_request = InsertTableOnlineRequest.new(document: request_document, 
   table: request_table, node_path: '')
insert_table = @words_api.insert_table_online(insert_table_request)

convert_request = ConvertDocumentRequest.new(
   document: insert_table.document.values[0], format: 'md')
convert = @words_api.convert_document(convert_request)
require 'aspose_words_cloud'

AsposeWordsCloud.configure do |config|
  config.client_data['ClientId'] = '####-####-####-####-####'
  config.client_data['ClientSecret'] = '##################'
end
@words_api = WordsAPI.new

request_document = File.open('Input1.md')
request_drawing_object = DrawingObjectInsert.new({:Height => 0, :Left => 0, :Top => 0, 
   :Width => 0, :RelativeHorizontalPosition => 'Margin', 
      :RelativeVerticalPosition => 'Margin', :WrapType => 'Inline'})
request_image_file = File.open('Input2.md')
insert_drawing_object_request = InsertDrawingObjectOnlineRequest.new(
   document: request_document, drawing_object: request_drawing_object, 
      image_file: request_image_file, node_path: 'sections/0')
insert_drawing_object = @words_api.insert_drawing_object_online(insert_drawing_object_request)

convert_request = ConvertDocumentRequest.new(
   document: insert_drawing_object.document.values[0], format: 'md')
convert = @words_api.convert_document(convert_request)
Run code
  
Copy Ruby code to the clipboard

How to edit Markdown Ruby REST API

  1. Install Aspose.Words Cloud for Ruby
  2. Add a library reference (import the library) to your Ruby project
  3. Load Markdown to edit in Ruby
  4. Insert content at the beginning of Markdown
  5. Download the result document from the cloud storage

Ruby library to use MD editing

Install Aspose.Words Cloud SDK for Ruby using RubyGems hosting service. Run gem install aspose_words_cloud to install the package. As an alternative, you can manually clone Aspose.Words Cloud SDK for Ruby source code from GitHub and use it in your project. Please follow these Instructions to quickly get the necessary security credentials and access our REST API.

System Requirements

Ruby 2.6 or newer

Refer to the Repository Documentation to see the details.

Other supported file formats

You can perform edit operation for other file formats:

5%

Subscribe to Aspose Product Updates

Get monthly newsletters and offers directly delivered to your mailbox.

© Aspose Pty Ltd 2001-2024. All Rights Reserved.