Quick Start

Get Inkfeed running in under a minute.

1. Create a Config File

Inkfeed uses a TOML configuration file. Create a config.toml in your working directory:

[general]
output_dir = "output"
embed_assets = true
output_formats = ["html", "md"]
max_workers = 8
max_retries = 3

[sources.hackernews]
type = "api"
display_name = "Hacker News"
frequency = "daily"
enabled = true
top_stories = 30
include_comments = true
max_comment_depth = 3
max_comments_per_level = 10
include_article_content = true

This minimal config fetches the top 30 Hacker News stories and outputs them as HTML and Markdown.

2. Run Inkfeed

inkfeed

Or point to a specific config:

inkfeed path/to/config.toml

3. Check the Output

After a successful run, you'll find your archived content in the output/ directory:

output/
├── html/
│   └── 2026-02-18/
│       ├── index.html          # Date index page
│       └── hackernews/
│           ├── index.html      # Source index page
│           └── story-slug.html # Individual articles
└── md/
    └── 2026-02-18/
        ├── index.md
        └── hackernews/
            ├── index.md
            └── story-slug.md

Open output/html/2026-02-18/index.html in your browser to browse the archive.

4. Add More Sources

Add an RSS feed to your config:

[sources.hackaday]
type = "rss"
display_name = "Hackaday"
frequency = "daily"
enabled = true
url = "http://www.hackaday.com/rss.xml"
max_articles = 30
include_article_content = true

Re-run inkfeed and the new source will be included alongside existing ones.

---

Next: Learn about all available Configuration options.