From 1341ab6266982af7dd23f3bc4efb9bd76513a260 Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Sat, 2 Aug 2025 16:57:30 +0200 Subject: [PATCH 1/4] docs: everything of configs readme --- configs-README.md | 87 +++++++++++++++++++ feed-directory/index.html | 1 + get-involved/contributing.md | 23 ++++- html2rss-configs/how-to/index.md | 11 +++ html2rss-configs/how-to/usage-with-web.md | 11 +++ html2rss-configs/index.md | 10 +++ html2rss-configs/reference/ci-building.md | 11 +++ html2rss-configs/reference/index.md | 11 +++ .../reference/programmatic-usage.md | 27 ++++++ html2rss-configs/tutorials/index.md | 11 +++ 10 files changed, 200 insertions(+), 3 deletions(-) create mode 100644 configs-README.md create mode 100644 html2rss-configs/how-to/index.md create mode 100644 html2rss-configs/how-to/usage-with-web.md create mode 100644 html2rss-configs/index.md create mode 100644 html2rss-configs/reference/ci-building.md create mode 100644 html2rss-configs/reference/index.md create mode 100644 html2rss-configs/reference/programmatic-usage.md create mode 100644 html2rss-configs/tutorials/index.md diff --git a/configs-README.md b/configs-README.md new file mode 100644 index 00000000..941b7e38 --- /dev/null +++ b/configs-README.md @@ -0,0 +1,87 @@ +![html2rss logo](https://github.com/html2rss/html2rss/raw/master/support/logo.png) + +# html2rss-configs + +✌️ This repository contains [`html2rss`](https://github.com/html2rss/html2rss) _feed configs_ for many websites. +👉 Find all _feed configs_ in the [`configs/` directory](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs). +☝️ A handy usage method is via [`html2rss-web`](https://github.com/html2rss/html2rss-web). +💪 Contributions are more than welcome! +[Fork this repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo), +add your _feed config_ and +[create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). + +## Contributing + +The html2rss "ecosystem" is a community project. We welcome contributions of all kinds. This includes new feed configs, suggesting and implementing features, providing bug fixes, documentation improvements, and any other kind of help. + +### Adding a new feed config + +Which way you choose to add a new feed config is up to you. You can do it manually or risk the "wizard-like" generator. Please [submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)! + +After you're done, you can test your feed config by running `bundle exec html2rss feed lib/html2rss/configs//.yml`. + +#### Prefered way: manually + +1. Fork this repo and run `bundle install` (you need to have Ruby >= 3.1 installed). +2. Create a new folder and file following ths convention: `lib/html2rss/configs//.yml` +3. Create the feed config in the `.yml` file. +4. Add this spec file in the `spec/html2rss/configs//_spec.rb` file. + +```ruby + RSpec.describe '/' do + include_examples 'config.yml', described_class + end +``` + +#### Using the "wizard-like" generator + +There's was a try to build a wizard like TUI based generator for that! 🆒 It hasn't seen much love, tho, but it might gets you going or crash in the middle of the process. + +1. Fork this repo and run `bundle install` (you need to have Ruby >= 3.1 installed). +2. Start the generator by typing: `bin/generator` +3. Build your feed config and answer 'y' in the last step to create the files. +4. Optionally, edit the created files. Read [`html2rss`'s README](https://github.com/html2rss/html2rss/blob/master/README.md) to see what is possible or browse [existing configs](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs) for inspiration. +5. To test, run: + `bundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever` + +## Using dynamic parameters in `channel` attributes + +When you're using dynamic parameters, you have to provide the parameters to the spec, too: + +```ruby +include_examples 'config.yml', 'domainname.tld/whatever.yml', id: 42 +``` + +CLI usage: + +```sh +bundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever id=42 +``` + +## Programmatic usage + +Add to your Gemfile: + +```ruby +gem 'html2rss-configs', git: 'https://github.com/html2rss/html2rss-configs.git' +``` + +Use it in your code: + +```ruby +require 'html2rss/configs' + +config = Html2rss::Configs.find_by_name('domainname.tld/whatever') +``` + +This will return the _feed config_. + +## Usage with `html2rss-web` + +If you're running [`html2rss-web`](https://github.com/html2rss/html2rss-web), +you have nothing more to do! 🎉 Just request them from your instance at path: `/.rss` and you'll be served the RSS. + +## CI: Building on the CI + +Modifying existing or adding new _feed configs_ will trigger the CI to fetch the feed +and check for the presence of feed items. diff --git a/feed-directory/index.html b/feed-directory/index.html index 2aeef3a8..4d9ff82c 100644 --- a/feed-directory/index.html +++ b/feed-directory/index.html @@ -3,6 +3,7 @@ title: Feed Directory nav_order: 2 noindex: true +has_children: true ---
diff --git a/get-involved/contributing.md b/get-involved/contributing.md index 40cb43e1..c7ce491d 100644 --- a/get-involved/contributing.md +++ b/get-involved/contributing.md @@ -25,7 +25,24 @@ Here are some of the ways you can contribute to the `html2rss` project: Are you missing an RSS feed for a website? You can create your own feed config and share it with the community. It's a great way to get started with `html2rss` and help other users. -[**Learn how to create a feed config**](https://github.com/html2rss/html2rss-configs) +The html2rss "ecosystem" is a community project. We welcome contributions of all kinds. This includes new feed configs, suggesting and implementing features, providing bug fixes, documentation improvements, and any other kind of help. + +Which way you choose to add a new feed config is up to you. You can do it manually. Please [submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)! + +After you're done, you can test your feed config by running `bundle exec html2rss feed lib/html2rss/configs//.yml`. + +#### Prefered way: manually + +1. Fork this repo and run `bundle install` (you need to have Ruby >= 3.1 installed). +2. Create a new folder and file following ths convention: `lib/html2rss/configs//.yml` +3. Create the feed config in the `.yml` file. +4. Add this spec file in the `spec/html2rss/configs//_spec.rb` file. + +```ruby + RSpec.describe '/' do + include_examples 'config.yml', described_class + end +``` ### 2. Improve this Website @@ -37,13 +54,13 @@ This website is built with Jekyll and is hosted on GitHub Pages. If you have any The [`html2rss-web`](https://github.com/html2rss/html2rss-web) project is a web application that allows you to create and manage your RSS feeds through a user-friendly interface. You can host your own public instance to help other users create feeds. -[**Learn how to host a public instance**](https://github.com/html2rss/html2rss-web/wiki/Instances) +[**Learn how to host a public instance**]({{ '/web-application/how-to/deployment' | relative_url }}) ### 4. Improve the `html2rss` Gem Are you a Ruby developer? You can help us improve the core `html2rss` gem. Whether you're fixing a bug, adding a new feature, or improving the documentation, your contributions are welcome. -[**Check out the repository on GitHub**](https://github.com/html2rss/html2rss) +[**Check out the documentation for the `html2rss` Gem**]({{ '/ruby-gem/' | relative_url }}) ### 5. Report Bugs & Discuss Features diff --git a/html2rss-configs/how-to/index.md b/html2rss-configs/how-to/index.md new file mode 100644 index 00000000..c280bfa6 --- /dev/null +++ b/html2rss-configs/how-to/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: How-To Guides +has_children: true +parent: html2rss-configs +nav_order: 2 +--- + +# How-To Guides + +This section provides practical guides on how to perform specific tasks with `html2rss-configs`. diff --git a/html2rss-configs/how-to/usage-with-web.md b/html2rss-configs/how-to/usage-with-web.md new file mode 100644 index 00000000..e4ca860b --- /dev/null +++ b/html2rss-configs/how-to/usage-with-web.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Usage with html2rss-web +parent: How-To Guides +grand_parent: html2rss-configs +nav_order: 3 +--- + +# Usage with `html2rss-web` + +If you're running [`html2rss-web`](https://github.com/html2rss/html2rss-web), you have nothing more to do! Just request them from your instance at path: `/.rss` and you'll be served the RSS. diff --git a/html2rss-configs/index.md b/html2rss-configs/index.md new file mode 100644 index 00000000..1a03d6ea --- /dev/null +++ b/html2rss-configs/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: html2rss-configs +has_children: true +nav_order: 5 +--- + +# html2rss-configs Documentation + +This section provides comprehensive documentation for the `html2rss-configs` project, which contains feed configurations for various websites. You can find a list of all available configurations in the [Feed Directory]({{ '/feed-directory/' | relative_url }}). diff --git a/html2rss-configs/reference/ci-building.md b/html2rss-configs/reference/ci-building.md new file mode 100644 index 00000000..84e67223 --- /dev/null +++ b/html2rss-configs/reference/ci-building.md @@ -0,0 +1,11 @@ +--- +layout: default +title: CI Building +parent: Reference +grand_parent: html2rss-configs +nav_order: 2 +--- + +# CI: Building on the CI + +Modifying existing or adding new feed configurations will trigger the CI to fetch the feed and check for the presence of feed items. diff --git a/html2rss-configs/reference/index.md b/html2rss-configs/reference/index.md new file mode 100644 index 00000000..26742f25 --- /dev/null +++ b/html2rss-configs/reference/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Reference +has_children: true +parent: html2rss-configs +nav_order: 3 +--- + +# Reference + +This section provides detailed reference information for `html2rss-configs`. diff --git a/html2rss-configs/reference/programmatic-usage.md b/html2rss-configs/reference/programmatic-usage.md new file mode 100644 index 00000000..e1847500 --- /dev/null +++ b/html2rss-configs/reference/programmatic-usage.md @@ -0,0 +1,27 @@ +--- +layout: default +title: Programmatic Usage +parent: Reference +grand_parent: html2rss-configs +nav_order: 1 +--- + +# Programmatic Usage + +You can use `html2rss-configs` programmatically in your Ruby applications. + +Add to your Gemfile: + +```ruby +gem 'html2rss-configs', git: 'https://github.com/html2rss/html2rss-configs.git' +``` + +Use it in your code: + +```ruby +require 'html2rss/configs' + +config = Html2rss::Configs.find_by_name('domainname.tld/whatever') +``` + +This will return the feed configuration. diff --git a/html2rss-configs/tutorials/index.md b/html2rss-configs/tutorials/index.md new file mode 100644 index 00000000..cc82bf63 --- /dev/null +++ b/html2rss-configs/tutorials/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Tutorials +has_children: true +parent: html2rss-configs +nav_order: 1 +--- + +# Tutorials + +This section provides step-by-step guides to help you get started with `html2rss-configs`. From 6c30ca7e038c278b25389431f2be8c736a009fec Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Sat, 2 Aug 2025 17:22:37 +0200 Subject: [PATCH 2/4] . Signed-off-by: Gil Desmarais --- configs-README.md | 87 --------- get-involved/contributing.md | 2 +- html2rss-configs/how-to/index.md | 11 -- html2rss-configs/how-to/usage-with-web.md | 11 -- html2rss-configs/index.md | 169 +++++++++++++++++- html2rss-configs/reference/ci-building.md | 11 -- html2rss-configs/reference/index.md | 11 -- .../reference/programmatic-usage.md | 27 --- html2rss-configs/tutorials/index.md | 11 -- 9 files changed, 167 insertions(+), 173 deletions(-) delete mode 100644 configs-README.md delete mode 100644 html2rss-configs/how-to/index.md delete mode 100644 html2rss-configs/how-to/usage-with-web.md delete mode 100644 html2rss-configs/reference/ci-building.md delete mode 100644 html2rss-configs/reference/index.md delete mode 100644 html2rss-configs/reference/programmatic-usage.md delete mode 100644 html2rss-configs/tutorials/index.md diff --git a/configs-README.md b/configs-README.md deleted file mode 100644 index 941b7e38..00000000 --- a/configs-README.md +++ /dev/null @@ -1,87 +0,0 @@ -![html2rss logo](https://github.com/html2rss/html2rss/raw/master/support/logo.png) - -# html2rss-configs - -✌️ This repository contains [`html2rss`](https://github.com/html2rss/html2rss) _feed configs_ for many websites. -👉 Find all _feed configs_ in the [`configs/` directory](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs). -☝️ A handy usage method is via [`html2rss-web`](https://github.com/html2rss/html2rss-web). -💪 Contributions are more than welcome! -[Fork this repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo), -add your _feed config_ and -[create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). - -## Contributing - -The html2rss "ecosystem" is a community project. We welcome contributions of all kinds. This includes new feed configs, suggesting and implementing features, providing bug fixes, documentation improvements, and any other kind of help. - -### Adding a new feed config - -Which way you choose to add a new feed config is up to you. You can do it manually or risk the "wizard-like" generator. Please [submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)! - -After you're done, you can test your feed config by running `bundle exec html2rss feed lib/html2rss/configs//.yml`. - -#### Prefered way: manually - -1. Fork this repo and run `bundle install` (you need to have Ruby >= 3.1 installed). -2. Create a new folder and file following ths convention: `lib/html2rss/configs//.yml` -3. Create the feed config in the `.yml` file. -4. Add this spec file in the `spec/html2rss/configs//_spec.rb` file. - -```ruby - RSpec.describe '/' do - include_examples 'config.yml', described_class - end -``` - -#### Using the "wizard-like" generator - -There's was a try to build a wizard like TUI based generator for that! 🆒 It hasn't seen much love, tho, but it might gets you going or crash in the middle of the process. - -1. Fork this repo and run `bundle install` (you need to have Ruby >= 3.1 installed). -2. Start the generator by typing: `bin/generator` -3. Build your feed config and answer 'y' in the last step to create the files. -4. Optionally, edit the created files. Read [`html2rss`'s README](https://github.com/html2rss/html2rss/blob/master/README.md) to see what is possible or browse [existing configs](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs) for inspiration. -5. To test, run: - `bundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever` - -## Using dynamic parameters in `channel` attributes - -When you're using dynamic parameters, you have to provide the parameters to the spec, too: - -```ruby -include_examples 'config.yml', 'domainname.tld/whatever.yml', id: 42 -``` - -CLI usage: - -```sh -bundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever id=42 -``` - -## Programmatic usage - -Add to your Gemfile: - -```ruby -gem 'html2rss-configs', git: 'https://github.com/html2rss/html2rss-configs.git' -``` - -Use it in your code: - -```ruby -require 'html2rss/configs' - -config = Html2rss::Configs.find_by_name('domainname.tld/whatever') -``` - -This will return the _feed config_. - -## Usage with `html2rss-web` - -If you're running [`html2rss-web`](https://github.com/html2rss/html2rss-web), -you have nothing more to do! 🎉 Just request them from your instance at path: `/.rss` and you'll be served the RSS. - -## CI: Building on the CI - -Modifying existing or adding new _feed configs_ will trigger the CI to fetch the feed -and check for the presence of feed items. diff --git a/get-involved/contributing.md b/get-involved/contributing.md index c7ce491d..00552620 100644 --- a/get-involved/contributing.md +++ b/get-involved/contributing.md @@ -33,7 +33,7 @@ After you're done, you can test your feed config by running `bundle exec html2rs #### Prefered way: manually -1. Fork this repo and run `bundle install` (you need to have Ruby >= 3.1 installed). +1. Fork the `html2rss-config` git repository and run `bundle install` (you need to have Ruby >= 3.3 installed). 2. Create a new folder and file following ths convention: `lib/html2rss/configs//.yml` 3. Create the feed config in the `.yml` file. 4. Add this spec file in the `spec/html2rss/configs//_spec.rb` file. diff --git a/html2rss-configs/how-to/index.md b/html2rss-configs/how-to/index.md deleted file mode 100644 index c280bfa6..00000000 --- a/html2rss-configs/how-to/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: How-To Guides -has_children: true -parent: html2rss-configs -nav_order: 2 ---- - -# How-To Guides - -This section provides practical guides on how to perform specific tasks with `html2rss-configs`. diff --git a/html2rss-configs/how-to/usage-with-web.md b/html2rss-configs/how-to/usage-with-web.md deleted file mode 100644 index e4ca860b..00000000 --- a/html2rss-configs/how-to/usage-with-web.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: Usage with html2rss-web -parent: How-To Guides -grand_parent: html2rss-configs -nav_order: 3 ---- - -# Usage with `html2rss-web` - -If you're running [`html2rss-web`](https://github.com/html2rss/html2rss-web), you have nothing more to do! Just request them from your instance at path: `/.rss` and you'll be served the RSS. diff --git a/html2rss-configs/index.md b/html2rss-configs/index.md index 1a03d6ea..36559997 100644 --- a/html2rss-configs/index.md +++ b/html2rss-configs/index.md @@ -1,10 +1,173 @@ --- layout: default title: html2rss-configs -has_children: true +has_children: false nav_order: 5 --- -# html2rss-configs Documentation +# Creating Feed Configurations -This section provides comprehensive documentation for the `html2rss-configs` project, which contains feed configurations for various websites. You can find a list of all available configurations in the [Feed Directory]({{ '/feed-directory/' | relative_url }}). +Welcome to the guide for `html2rss-configs`. This document explains how to create your own configuration files to convert any website into an RSS feed. + +You can find a list of all community-contributed configurations in the [Feed Directory]({{ '/feed-directory/' | relative_url }}). + +--- + +## Core Concepts + +An `html2rss` config is a YAML file that defines how to extract data from a web page. It consists of two main building blocks: `channel` and `selectors`. + +### The `channel` Block + +The `channel` block contains metadata about the RSS feed itself, such as its title and the source URL. + +**Example:** + +```yaml +channel: + url: https://example.com/blog + title: My Awesome Blog +``` + +For a complete list of all available channel options, please see the [Channel Reference]({{ '/ruby-gem/reference/channel/' | relative_url }}). + +### The `selectors` Block + +The `selectors` block is the core of the configuration, defining the rules for extracting content. It always contains an `items` selector to identify the list of articles and individual selectors for the data points within each item (e.g., `title`, `link`). + +**Example:** + +```yaml +selectors: + items: + selector: "article.post" + title: + selector: "h2 a" + link: + selector: "h2 a" +``` + +For a comprehensive guide on all available selectors, extractors, and post-processors, please see the [Selectors Reference]({{ '/ruby-gem/reference/selectors/' | relative_url }}). + +--- + +## Tutorial: Your First Config + +This tutorial walks you through creating a basic configuration file from scratch. + +### Step 1: Identify the Target Content + +First, identify the HTML structure of the website you want to create a feed for. For this example, we'll use a simple blog structure: + +```html +
+
+

First Post

+

This is the summary of the first post.

+
+
+

Second Post

+

This is the summary of the second post.

+
+
+``` + +### Step 2: Create the Config File and Define the Channel + +Create a new YAML file (e.g., `my-blog.yml`) and define the `channel`: + +```yaml +# my-blog.yml +channel: + url: https://example.com/blog + title: My Awesome Blog + description: The latest news from my awesome blog. +``` + +### Step 3: Define the Selectors + +Next, add the `selectors` block to extract the content for each post. + +```yaml +# my-blog.yml +selectors: + items: + selector: "article.post" + title: + selector: "h2 a" + link: + selector: "h2 a" + description: + selector: "p" +``` + +- `items`: This CSS selector identifies the container for each article. +- `title`, `link`, `description`: These selectors target the specific data points within each item. For a `link` selector, `html2rss` defaults to extracting the `href` attribute from the matched `` tag. + +--- + +## Advanced Techniques + +### Handling Pagination + +To aggregate content from multiple pages, use the `pagination` option within the `items` selector. + +```yaml +selectors: + items: + selector: ".post-listing .post" + pagination: + selector: ".pagination .next-page" + limit: 5 # Optional: sets the maximum number of pages to follow +``` + +### Dynamic Feeds with Parameters + +Use the `parameters` block to create flexible configs. This is useful for feeds based on search terms, categories, or regions. + +```yaml +# news-search.yml +parameters: + query: + type: string + default: "technology" + +channel: + url: "https://news.example.com/search?q={query}" + title: "News results for '{query}'" +``` + +--- + +## Contributing Your Config + +Have you created a config that others might find useful? We strongly encourage you to contribute it to the project! By sharing your config, you make it available to all users of the public `html2rss-web` service and the Feed Directory. + +To contribute, please [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to the `html2rss-configs` repository. + +--- + +## Usage and Integration + +### With `html2rss-web` + +Once your pull request is reviewed and merged, your config will become available on the public [`html2rss-web`]({{ '/web-application/' | relative_url }}) instance. You can then access it at the path `/.rss`. + +### Programmatic Usage in Ruby + +You can also use `html2rss-configs` programmatically in your Ruby applications. + +Add this to your Gemfile: + +```ruby +gem 'html2rss-configs', git: 'https://github.com/html2rss/html2rss-configs.git' +``` + +And use it in your code: + +```ruby +require 'html2rss/configs' + +config = Html2rss::Configs.find_by_name('domainname.tld/whatever') +rss = Html2rss.feed(config) +``` diff --git a/html2rss-configs/reference/ci-building.md b/html2rss-configs/reference/ci-building.md deleted file mode 100644 index 84e67223..00000000 --- a/html2rss-configs/reference/ci-building.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: CI Building -parent: Reference -grand_parent: html2rss-configs -nav_order: 2 ---- - -# CI: Building on the CI - -Modifying existing or adding new feed configurations will trigger the CI to fetch the feed and check for the presence of feed items. diff --git a/html2rss-configs/reference/index.md b/html2rss-configs/reference/index.md deleted file mode 100644 index 26742f25..00000000 --- a/html2rss-configs/reference/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: Reference -has_children: true -parent: html2rss-configs -nav_order: 3 ---- - -# Reference - -This section provides detailed reference information for `html2rss-configs`. diff --git a/html2rss-configs/reference/programmatic-usage.md b/html2rss-configs/reference/programmatic-usage.md deleted file mode 100644 index e1847500..00000000 --- a/html2rss-configs/reference/programmatic-usage.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: Programmatic Usage -parent: Reference -grand_parent: html2rss-configs -nav_order: 1 ---- - -# Programmatic Usage - -You can use `html2rss-configs` programmatically in your Ruby applications. - -Add to your Gemfile: - -```ruby -gem 'html2rss-configs', git: 'https://github.com/html2rss/html2rss-configs.git' -``` - -Use it in your code: - -```ruby -require 'html2rss/configs' - -config = Html2rss::Configs.find_by_name('domainname.tld/whatever') -``` - -This will return the feed configuration. diff --git a/html2rss-configs/tutorials/index.md b/html2rss-configs/tutorials/index.md deleted file mode 100644 index cc82bf63..00000000 --- a/html2rss-configs/tutorials/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: Tutorials -has_children: true -parent: html2rss-configs -nav_order: 1 ---- - -# Tutorials - -This section provides step-by-step guides to help you get started with `html2rss-configs`. From f8d7faba3ded7337220fec63d01d33cc1296650c Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Sat, 2 Aug 2025 17:31:27 +0200 Subject: [PATCH 3/4] Update get-involved/contributing.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- get-involved/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-involved/contributing.md b/get-involved/contributing.md index 00552620..cd2ee8c7 100644 --- a/get-involved/contributing.md +++ b/get-involved/contributing.md @@ -34,7 +34,7 @@ After you're done, you can test your feed config by running `bundle exec html2rs #### Prefered way: manually 1. Fork the `html2rss-config` git repository and run `bundle install` (you need to have Ruby >= 3.3 installed). -2. Create a new folder and file following ths convention: `lib/html2rss/configs//.yml` +2. Create a new folder and file following this convention: `lib/html2rss/configs//.yml` 3. Create the feed config in the `.yml` file. 4. Add this spec file in the `spec/html2rss/configs//_spec.rb` file. From 2932bf157650d8a6c2856b1db5ece3d4b89912a6 Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Sat, 2 Aug 2025 17:32:17 +0200 Subject: [PATCH 4/4] Update get-involved/contributing.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- get-involved/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-involved/contributing.md b/get-involved/contributing.md index cd2ee8c7..a5306b83 100644 --- a/get-involved/contributing.md +++ b/get-involved/contributing.md @@ -31,7 +31,7 @@ Which way you choose to add a new feed config is up to you. You can do it manual After you're done, you can test your feed config by running `bundle exec html2rss feed lib/html2rss/configs//.yml`. -#### Prefered way: manually +#### Preferred way: manually 1. Fork the `html2rss-config` git repository and run `bundle install` (you need to have Ruby >= 3.3 installed). 2. Create a new folder and file following this convention: `lib/html2rss/configs//.yml`