Skip to content

Commit 0afde42

Browse files
gildesmaraisgildesmarais
committed
feat: style the site within the theme and add more content
1 parent e62ff60 commit 0afde42

File tree

11 files changed

+109
-77
lines changed

11 files changed

+109
-77
lines changed

‎404.html

+3-19
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,7 @@
33
layout: default
44
---
55

6-
<style type="text/css" media="screen">
7-
.container {
8-
margin: 10px auto;
9-
max-width: 600px;
10-
text-align: center;
11-
}
12-
h1 {
13-
margin: 30px 0;
14-
font-size: 4em;
15-
line-height: 1;
16-
letter-spacing: -1px;
17-
}
18-
</style>
6+
<h1>404</h1>
197

20-
<div class="container">
21-
<h1>404</h1>
22-
23-
<p><strong>Page not found :(</strong></p>
24-
<p>The requested page could not be found.</p>
25-
</div>
8+
<p><strong>Page not found :(</strong></p>
9+
<p>The requested page could not be found.</p>

‎Makefile

-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,5 @@ update:
1919
bin/data-update
2020

2121
serve: setup
22-
open http://127.0.0.1:4000/
2322
bundle exec jekyll s --drafts --trace
2423

‎_config.yml

+13
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,22 @@ description: |
1616
github_username: "html2rss"
1717

1818
theme: just-the-docs
19+
logo: assets/images/logo.png
20+
21+
aux_links:
22+
"GitHub":
23+
- "https://github.com/html2rss"
1924

2025
header_pages:
2126
- configs/index.html
27+
- contributing.md
28+
29+
# Footer "Edit this page on GitHub" link text
30+
gh_edit_link: true # show or hide edit this page link
31+
gh_edit_link_text: "Edit this page on GitHub."
32+
gh_edit_repository: "https://github.com/html2rss/html2rss.github.io" # the github URL for your repo
33+
gh_edit_branch: "main" # the branch that your docs is served from
34+
gh_edit_view_mode: "tree"
2235

2336
sass:
2437
style: compressed

‎_includes/head_custom.html

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55
name="robots"
66
content="{% if page.noindex %}noindex, noarchive, follow{% else %}index, follow{% endif %}"
77
/>
8+
<link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}" />

‎about.md

-17
This file was deleted.

‎assets/css/sass/base.scss

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
// start writing scss here. remember to import any new file from main.scss
1+
#configs input {
2+
width: 100%;
3+
font-family: monospace;
4+
background-color: transparent;
5+
border: 0;
6+
border-radius: 0;
7+
}

‎assets/images/logo.png

7.24 KB
Loading

‎configs/index.html

+39-33
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,44 @@
11
---
2-
layout: page
3-
title: Configs
2+
layout: default
3+
title: All feeds
44
noindex: true
5+
nav_order: 1
56
---
67

78
<noscript>
89
This site needs JavaScript to link to the feed URL!
910
</noscript>
1011

1112
<div id="configs">
12-
<fieldset>
13-
<legend>Instance Setup</legend>
13+
<fieldset class="bg-grey-lt-000 mb-4 py-1 px-2">
14+
<legend class="fs-5">Instance URL</legend>
1415

15-
<p>
16-
Find publicly available instances in the
17-
<a href="https://github.com/gildesmarais/html2rss-web/wiki/Instances"
18-
target="_blank"
19-
>wiki</a>.
20-
</p>
21-
22-
<label>
23-
Instance URL:
24-
<input type="text" name="instance" value="https://1.h2r.workers.dev">
25-
</label>
16+
<input type="text" name="instance" value="https://1.h2r.workers.dev" autofocus="true" class="bg-grey-lt-100 p-2">
2617
</fieldset>
2718

19+
<p class="fs-4">
20+
Find publicly available instances in the
21+
<a href="https://github.com/gildesmarais/html2rss-web/wiki/Instances"
22+
target="_blank"
23+
>wiki</a>
24+
or
25+
<a href="https://github.com/gildesmarais/html2rss-web"
26+
target="_blank"
27+
>host your own</a>.
28+
</p>
2829

2930
{% for config in site.data.configs %}
30-
<details>
31-
<summary>{{ config.domain }}/{{ config.name }}</summary>
31+
<article class="bg-grey-lt-000 my-8 py-1 px-2">
32+
<h2>
33+
<span>{{ config.domain }}</span
34+
><span class="text-yellow-300">/</span
35+
><span>{{ config.name }}</span>
36+
</h2>
3237

33-
<ul>
38+
<dl>
3439
{%- if config.channel.url -%}
35-
<li>
40+
<dt>URL to scrape</dt>
41+
<dd>
3642
{%- if config.valid_channel_url -%}
3743
<a href="{{ config.channel.url }}"
3844
target="_blank"
@@ -41,32 +47,27 @@
4147
{%- else -%}
4248
{{ config.channel.url | xml_escape }}
4349
{%- endif -%}
44-
</li>
45-
{%- endif -%}
46-
47-
{%- if config.channel.description -%}
48-
<li>{{ config.channel.description }}</li>
50+
</dd>
4951
{%- endif -%}
5052

5153
{%- if config.channel.time_zone -%}
52-
<li>{{ config.channel.time_zone }}</li>
53-
{%- endif -%}
54-
55-
{%- if config.channel.ttl -%}
56-
<li>{{ config.channel.ttl }}</li>
54+
<dt>Time zone</dt>
55+
<dd>{{ config.channel.time_zone }}</dd>
5756
{%- endif -%}
5857

5958
{%- if config.channel.language -%}
60-
<li>{{ config.channel.language }}</li>
59+
<dt>Language</dt>
60+
<dd>{{ config.channel.language }}</dd>
6161
{%- endif -%}
62-
</ul>
62+
</dl>
6363

6464
{%- if config.valid_channel_url -%}
6565
<a href="#"
6666
data-bind-click="show"
6767
data-path="{{ config.domain }}/{{ config.name }}.rss"
68+
class="btn btn-primary fs-3 mb-4 mb-md-0 mr-2"
6869
rel="noopener noreferrer"
69-
>Show</a>
70+
>Show RSS</a>
7071
{%- else -%}
7172
<p>
7273
<em>This channel requires parameters to function.</em>
@@ -76,7 +77,12 @@
7677
</code>
7778
</p>
7879
{%- endif -%}
79-
</details>
80+
81+
<a href="https://github.com/gildesmarais/html2rss-configs/blob/master/lib/html2rss/configs/{{ config.domain }}/{{ config.name }}.yml"
82+
class="btn fs-3 mb-4 mb-md-0">
83+
View on Github
84+
</a>
85+
</article>
8086
{% endfor %}
8187
</div>
8288

‎contributing.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default
3+
title: Contributing
4+
nav_order: 10
5+
---
6+
7+
There are many ways to contribute. Contributions are very welcome!
8+
9+
## Create a feed config
10+
11+
Are you missing an RSS for a site? Create your config and add make it available in the ecosystem. [It's easy, just have a look and try it out!](https://github.com/gildesmarais/html2rss-configs)
12+
13+
## Improve this website
14+
15+
This website is build with Jekyll and Github Actions. [Find the source code here.](https://github.com/html2rss/html2rss.github.io)
16+
17+
## Host your own public instance
18+
19+
The [html2rss-web project](https://github.com/gildesmarais/html2rss-web) is a rolling release web application which comes with the latest html2rss-configs build in.
20+
21+
Setup and maintain your instance. Do not forget to add your instance to [the instances list in the wiki](https://github.com/gildesmarais/html2rss-web/wiki/Instances) so that others can start using it.
22+
23+
## Improve the html2rss gem
24+
25+
Are you missing a feature in the [html2rss gem](https://github.com/gildesmarais/html2rss)? Did you find a bug? Head to the [repository on Github](https://github.com/gildesmarais/html2rss) and start working on it.

‎index.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default
3+
title: Home
4+
nav_order: 0
5+
---
6+
7+
<div class="fs-6 fw-300">
8+
html2rss build RSS feeds from websites which do not have one.
9+
</div>
10+
11+
<hr>
12+
13+
<p>
14+
Everyone can host their own html2rss-web instance. There are public instances for those who can't or won't.
15+
</p>
16+
17+
<p>
18+
html2rss provides many feed configs out of the box. Building the URL to get the feeds involves tinkering which not everybody likes.
19+
<br>
20+
This website simplifies the building of the feed URL by providing helpful tools.
21+
</p>

‎index.md

-6
This file was deleted.

0 commit comments

Comments
 (0)