Web & HTML Tools
HTML to MD Ruby Overview
Convert HTML and HTM pages into clean, readable Markdown (.md) through a fast, reliable Ruby SDK. Document structure is preserved: headings, lists, links, code blocks, and tables where possible. Great for documentation pipelines, wikis, CMS imports, version controlled content, and preparing web content for LLM and RAG pipelines.
The conversion is tunable: produce GitHub flavored Markdown, remove comments, choose the list bullet character, and decide how unsupported tags are handled: passed through, dropped, or bypassed keeping their content. Scripts, stylesheets and other markup that carries no readable text is always removed first, so the result stays free of noise.
The Images parameter decides what happens to the pictures on a page. By default images stay unchanged: linked images remain links and embedded images stay embedded. Use embed for one self contained file, extract to get the images as separate files, remove for the most compact text, or describe to let an AI model turn images into text: scanned paragraphs and tables are transcribed, charts and photos get short descriptions, and decorative images are dropped. Images referenced by URL are downloaded when needed, and the last option produces text only Markdown for LLM and RAG pipelines.
Simply upload your HTML and receive a UTF-8 Markdown file ready to edit, publish, or feed to a model.
Lightning Fast Conversions
Process and convert files in seconds with our high-performance cloud infrastructure.
Accuracy Guaranteed
Our advanced algorithms ensure pixel-perfect and content-accurate file conversions.
Enterprise-Grade Security
ISO 27001, HIPAA, and GDPR compliant with encrypted file processing.
Global Infrastructure
Strategically located servers ensure low latency and high availability worldwide.
Developer Friendly
Comprehensive SDKs and clear documentation for quick and simple integration.
Time-Saving Automation
Automate repetitive document workflows and focus on what matters most.
Customizable Parameters
Fine-tune your automation with these powerful conversion options
File
File Supported formats: .html .htmFile to be converted. Value can be URL or file content.
GithubFlavored
Bool Default: FalseCreate GitHub-flavored markdown GFM.
RemoveComments
Bool Default: FalseRemove comment tags.
UnsupportedTags
Collection Default: PassThroughSets the rules on how to handle unsupported HTML tags. Markup that carries no document text is always removed first (scripts, stylesheets, document metadata), and HTML5 structural elements such as main, section and article are always unwrapped, keeping their content. This setting therefore applies to the tags that remain unrecognised after that.
PassThroughTags
StringEnter pass-through tags, separating them with commas. The tags will be copied to the MD document without processing. The UnsupportedTags property should be set to PassThrough.
ListBulletChar
String Default: -Set bullet list character.
Images
Collection Default: unchangedControls how images are handled in the resulting Markdown. Embed produces a self-contained document with images embedded as base64 data URIs. Extract saves images as separate files referenced by relative links, the result is a zip archive with the Markdown and image files, or a plain Markdown file when the document has no images. Remove replaces images with their alt text when available, producing compact output suited for machine processing. Describe replaces every image with AI generated text: scanned text and tables are transcribed, pictures become short descriptions, producing text-only Markdown for LLM and RAG scenarios. Unchanged does not transform images at all: linked images stay links and embedded images stay embedded. Images referenced by URL are downloaded when Embed, Extract or Describe is selected, and an image that cannot be downloaded keeps its original link.
StoreFile
Bool Default: FalseWhen the StoreFile parameter is set to True, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.
When StoreFile is set to False, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.
Step-by-Step Guide
Easy HTML to MD integration using our Ruby GEM
1. ConvertAPI Ruby library install
ConvertAPI provides a Ruby Gem that allows you to perform a HTML to MD conversion with just a few lines of code. First, install the ConvertAPI Ruby SDK:
Add this line to your application's Gemfile:
gem 'convert_api'
2. Authenticate your Ruby library
You can obtain your API Token by signing up for a free account. Once you sign up, you'll receive 250 free conversions instantly! Grab your API Token from the account dashboard, and authenticate the ConvertAPI Ruby library like this:
# get your API Token here: https://www.convertapi.com/a/auth
ConvertApi.configure do |config|
config.api_credentials = 'api_token'
end
3. Convert HTML to MD using Ruby in no time!
Once you have your authentication in place, simply copy-paste this html to md conversion code snippet into your Ruby project:
Integrate within minutes
Easy HTML to MD automation using our simple Ruby SDK
Compatible With all Ruby Frameworks & Tools
Businesses trust us
Highest rated File Conversion API on major B2B software listing platforms: Capterra, G2, and Trustpilot.
"ConvertAPI has been a game-changer for our document automation workflows. Their conversion accuracy and API reliability are unmatched in the industry for over 7 years."
"ConvertAPI is a reliable, cost-effective solution with a proven track record of stability. It has grown significantly in maturity, adopting enterprise-grade practices over the years."
"We've integrated ConvertAPI across our entire document processing platform. The performance is exceptional and the support team is always responsive. Highly recommended!"
Enterprise-Grade Security
We ensure that all document processing is handled securely in the cloud, adhering to industry-leading standards like ISO 27001, GDPR, and HIPAA. To enhance security even further, we can ensure that no files or data are stored on our servers and never leave your country.
Learn more about security