Skip to content

Commit fe1b045

Browse files
committed
refactor(docs): share onboarding content blocks
1 parent 4085637 commit fe1b045

4 files changed

Lines changed: 49 additions & 68 deletions

File tree

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
import { Aside } from "@astrojs/starlight/components";
3+
---
4+
5+
<Aside type="note" title="Automatic generation is optional">
6+
The "paste a website URL and generate a feed" workflow is not enabled by default. If you want it, continue
7+
with <a href="/web-application/how-to/use-automatic-feed-generation/">Use automatic feed generation</a>.
8+
</Aside>
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
import Code from "astro/components/Code.astro";
3+
4+
const code = `services:
5+
html2rss-web:
6+
image: gilcreator/html2rss-web
7+
restart: unless-stopped
8+
ports:
9+
- "127.0.0.1:3000:3000"
10+
volumes:
11+
- type: bind
12+
source: ./feeds.yml
13+
target: /app/config/feeds.yml
14+
read_only: true
15+
environment:
16+
RACK_ENV: production
17+
HEALTH_CHECK_USERNAME: health
18+
HEALTH_CHECK_PASSWORD: CHANGE_THIS_PASSWORD_BEFORE_USE
19+
BROWSERLESS_IO_WEBSOCKET_URL: ws://browserless:3001
20+
BROWSERLESS_IO_API_TOKEN: 6R0W53R135510
21+
22+
browserless:
23+
image: "ghcr.io/browserless/chromium"
24+
restart: unless-stopped
25+
ports:
26+
- "127.0.0.1:3001:3001"
27+
environment:
28+
PORT: 3001
29+
CONCURRENT: 10
30+
TOKEN: 6R0W53R135510`;
31+
---
32+
33+
<Code code={code} lang="yaml" />

src/content/docs/getting-started.mdx

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ sidebar:
55
order: 1
66
---
77

8-
import { Aside } from "@astrojs/starlight/components";
8+
import AutoGenerationOptional from "../../components/docs/AutoGenerationOptional.astro";
9+
import MinimalDockerCompose from "../../components/docs/MinimalDockerCompose.astro";
910

1011
Ready to get RSS feeds from any website? Run `html2rss-web` locally with Docker, verify the interface, then start with included feeds before you move on to custom configs.
1112

@@ -43,35 +44,7 @@ cd html2rss-web
4344

4445
Create a file called `docker-compose.yml` in your new folder. Start with the minimal local stack:
4546

46-
```yaml
47-
services:
48-
html2rss-web:
49-
image: gilcreator/html2rss-web:latest
50-
restart: unless-stopped
51-
ports:
52-
- "127.0.0.1:3000:3000"
53-
volumes:
54-
- type: bind
55-
source: ./feeds.yml
56-
target: /app/config/feeds.yml
57-
read_only: true
58-
environment:
59-
RACK_ENV: production
60-
HEALTH_CHECK_USERNAME: health
61-
HEALTH_CHECK_PASSWORD: CHANGE_THIS_PASSWORD_BEFORE_USE
62-
BROWSERLESS_IO_WEBSOCKET_URL: ws://browserless:3001
63-
BROWSERLESS_IO_API_TOKEN: 6R0W53R135510
64-
65-
browserless:
66-
image: "ghcr.io/browserless/chromium"
67-
restart: unless-stopped
68-
ports:
69-
- "127.0.0.1:3001:3001"
70-
environment:
71-
PORT: 3001
72-
CONCURRENT: 10
73-
TOKEN: 6R0W53R135510
74-
```
47+
<MinimalDockerCompose />
7548

7649
Add update automation such as Watchtower later, after the first run works.
7750

@@ -122,10 +95,7 @@ This is the easiest way to confirm the whole stack is healthy.
12295
- **Need a feed for a new site:** decide between auto-generation and a custom config
12396
- **Need stable, repeatable control:** move to [Creating Custom Feeds](/creating-custom-feeds)
12497

125-
<Aside type="note" title="Auto-generation is optional">
126-
Automatic feed generation is not enabled by default. If you want the "paste a URL and generate a feed"
127-
workflow, follow [Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/).
128-
</Aside>
98+
<AutoGenerationOptional />
12999

130100
## When To Use Each Option
131101

src/content/docs/web-application/getting-started.mdx

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ sidebar:
55
order: 2
66
---
77

8-
import { Aside } from "@astrojs/starlight/components";
8+
import AutoGenerationOptional from "../../../components/docs/AutoGenerationOptional.astro";
9+
import MinimalDockerCompose from "../../../components/docs/MinimalDockerCompose.astro";
910

1011
Ready to create RSS feeds? Run `html2rss-web` locally with Docker, verify the interface, then use included feeds before you move on to auto-generation or custom configs.
1112

@@ -43,35 +44,7 @@ cd html2rss-web
4344

4445
Create a file called `docker-compose.yml` in your new folder. Start with the minimal local stack:
4546

46-
```yaml
47-
services:
48-
html2rss-web:
49-
image: gilcreator/html2rss-web
50-
restart: unless-stopped
51-
ports:
52-
- "127.0.0.1:3000:3000"
53-
volumes:
54-
- type: bind
55-
source: ./feeds.yml
56-
target: /app/config/feeds.yml
57-
read_only: true
58-
environment:
59-
RACK_ENV: production
60-
HEALTH_CHECK_USERNAME: health
61-
HEALTH_CHECK_PASSWORD: please-set-YOUR-OWN-veeeeeery-l0ng-aNd-h4rd-to-gue55-Passw0rd!
62-
BROWSERLESS_IO_WEBSOCKET_URL: ws://browserless:3001
63-
BROWSERLESS_IO_API_TOKEN: 6R0W53R135510
64-
65-
browserless:
66-
image: "ghcr.io/browserless/chromium"
67-
restart: unless-stopped
68-
ports:
69-
- "127.0.0.1:3001:3001"
70-
environment:
71-
PORT: 3001
72-
CONCURRENT: 10
73-
TOKEN: 6R0W53R135510
74-
```
47+
<MinimalDockerCompose />
7548

7649
Add update automation such as Watchtower later, after the first run works.
7750

@@ -114,10 +87,7 @@ If you see the interface, the setup worked.
11487

11588
That proves the web app, feed config file, and request pipeline are all working together.
11689

117-
<Aside type="note" title="Automatic generation is optional">
118-
The "paste a website URL and generate a feed" workflow is not enabled by default. If you want it, continue
119-
with [Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/).
120-
</Aside>
90+
<AutoGenerationOptional />
12191

12292
---
12393

0 commit comments

Comments
 (0)