| layout | default |
|---|---|
| title | Installation |
| nav_order | 1 |
| parent | Ruby Gem |
This guide will walk you through the process of installing html2rss on your system. html2rss can be installed in several ways, depending on your preferred method and environment.
- Ruby: html2rss is built with Ruby. Ensure you have Ruby installed (version 3.2 or higher required). You can check your Ruby version by running
ruby -vin your terminal. If you don't have Ruby, visit ruby-lang.org for installation instructions. - Bundler (Recommended): Bundler is a Ruby gem that manages your application's dependencies. It's highly recommended for a smooth installation. Install it with
gem install bundler.
The simplest way to get html2rss for command-line usage is to install it as a Ruby gem.
gem install html2rssAfter installation, you should be able to run html2rss --version to confirm it's working.
If you're integrating html2rss into an existing Ruby project, add it to your Gemfile:
# Gemfile
gem 'html2rss'Then, run bundle install in your project directory.
For a quick start without local setup, you can develop html2rss directly in your browser using GitHub Codespaces:
The Codespace comes pre-configured with Ruby 3.4, all dependencies, and VS Code extensions ready to go!
To ensure html2rss is installed correctly, open your terminal and run:
html2rss --versionYou should see the installed version number. If you encounter any issues, please refer to the [Troubleshooting Guide]({{ "/support/troubleshooting" | relative_url }}).
Now that html2rss is installed, let's create your [first RSS feed]({{ '/ruby-gem/tutorials/your-first-feed' | relative_url }})!