Skip to content

Commit 919c47b

Browse files
committed
refactor: update documentation for clarity and consistency
1 parent a6112bc commit 919c47b

7 files changed

Lines changed: 32 additions & 33 deletions

File tree

feed-directory/index.html

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -87,35 +87,32 @@ <h3 class="card-title mb-0 text-mono fs-5">
8787
{%- endif -%}
8888
</div>
8989
<div class="card-body">
90-
<details>
91-
<summary>Details</summary>
92-
<dl>
93-
{%- if config.channel.url -%}
94-
<dt>URL to scrape</dt>
95-
<dd>
96-
{%- if config.valid_channel_url -%}
97-
<a
98-
href="{{ config.channel.url }}"
99-
class="config__url"
100-
target="_blank"
101-
rel="noopener noreferrer"
102-
>{{ config.channel.url }}</a
103-
>
104-
{%- else -%}
105-
<span class="config__url"
106-
>{{ config.channel.url | xml_escape }}</span
107-
>
108-
{%- endif -%}
109-
</dd>
110-
{%- endif -%} {%- if config.channel.time_zone -%}
111-
<dt>Time zone</dt>
112-
<dd>{{ config.channel.time_zone }}</dd>
113-
{%- endif -%} {%- if config.channel.language -%}
114-
<dt>Language</dt>
115-
<dd>{{ config.channel.language }}</dd>
90+
<dl>
91+
{%- if config.channel.url -%}
92+
<dt>URL to scrape</dt>
93+
<dd>
94+
{%- if config.valid_channel_url -%}
95+
<a
96+
href="{{ config.channel.url }}"
97+
class="config__url"
98+
target="_blank"
99+
rel="noopener noreferrer"
100+
>{{ config.channel.url }}</a
101+
>
102+
{%- else -%}
103+
<span class="config__url"
104+
>{{ config.channel.url | xml_escape }}</span
105+
>
116106
{%- endif -%}
117-
</dl>
118-
</details>
107+
</dd>
108+
{%- endif -%} {%- if config.channel.time_zone -%}
109+
<dt>Time zone</dt>
110+
<dd>{{ config.channel.time_zone }}</dd>
111+
{%- endif -%} {%- if config.channel.language -%}
112+
<dt>Language</dt>
113+
<dd>{{ config.channel.language }}</dd>
114+
{%- endif -%}
115+
</dl>
119116

120117
{%- if config.valid_channel_url -%}
121118
<div class="mt-4 d-flex-justify-content-between">

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The `html2rss` project is more than just a single tool. It's a collection of too
2727

2828
- **[html2rss-web]({{ '/web-application' | relative_url }}):** A user-friendly web application that makes it easy to create, manage, and share RSS feeds. This is the recommended starting point for most users.
2929
- **[html2rss (Ruby Gem)]({{ '/ruby-gem' | relative_url }}):** The core library that powers the web application. It provides a powerful and flexible command-line interface for creating custom RSS feeds.
30-
- **[html2rss-configs](https://github.com/html2rss/html2rss-configs):** A community-driven repository of pre-built feed configurations for popular websites, so you can get started quickly.
30+
- **[Feed Directory]({{ '/feed-directory' | relative_url }}):** A public listing of RSS feeds for websites of interest, powered by community-driven configurations.
3131

3232
---
3333

ruby-gem/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ has_children: true
66
permalink: /ruby-gem
77
---
88

9-
# The html2rss Ruby Gem
9+
# The html2rss Ruby Gem ([GitHub Repo](https://github.com/html2rss/html2rss))
1010

1111
This section provides detailed documentation for the `html2rss` Ruby gem. The gem is the core library that powers the `html2rss-web` application.
1212

ruby-gem/tutorials/installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ layout: default
33
title: Installation
44
nav_order: 2
55
parent: Tutorials
6+
grand_parent: Ruby Gem
67
permalink: /ruby-gem/tutorials/installation
78
---
89

ruby-gem/tutorials/your-first-feed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ layout: default
33
title: Your First Feed
44
nav_order: 3
55
parent: Tutorials
6+
grand_parent: Ruby Gem
67
permalink: /ruby-gem/tutorials/your-first-feed
78
---
89

web-application/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ permalink: /web-application
88

99
# html2rss-web
1010

11-
This web application scrapes websites to build and deliver RSS 2.0 feeds.
11+
This web application scrapes websites to build and deliver RSS 2.0 feeds. ([GitHub Repo](https://github.com/html2rss/html2rss-web))
1212

1313
## Features
1414

web-application/tutorials/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: default
3-
title: Tutorials
3+
title: Getting Started
44
nav_order: 1
55
permalink: /web-application/tutorials
66
parent: Web Application
77
---
88

9-
# Tutorials: Getting Started with html2rss-web
9+
# Getting Started with html2rss-web
1010

1111
In this guide, you'll launch the `html2rss-web` application on your local machine. By the end, you'll have a running instance and your first live RSS feed.
1212

0 commit comments

Comments
 (0)