close
Skip to main content
This release is versions behind 1.1.1 — the latest version of @5ouma/opml-generator.
Works with
This package works with Deno
This package works with Deno
JSR Score100%
Downloads1/wk
Publisheda year ago (1.0.5)

📰 Generate OPML file via TOML file easily

OPML Generator

📰 Generate OPML file via TOML file easily


GitHub Release JSR JSR Score
CI Release pre-commit codecov

Repobeats Analytics Image



📊 Usage

OPML Generator has 2 ways to convert TOML to OPML.

💻 On Local

  1. Prepare your TOML file (Reference: feeds.toml)

  2. Run this command

    deno run -A jsr:@5ouma/opml-generator
    
  3. Outputs are stored in the outputs directory separated by lists


🐙 On GitHub Actions

  1. Create two GitHub Gist:

  2. Prepare your repository to run

  3. Add Actions secrets from Settings > Secrets and variables | Actions in the sidebar

    🌍 Environment Variables

  4. Add gist-update.yml to your repository's .github/workflows directory.

🎉 Automatically update every 0 a.m. UTC



🌍 Environment Variables

Name Description GitHub Actions requires
TOML_GIST_ID Gist ID for feeds.toml yes
OPML_GIST_ID Gist ID for outputs yes
TOKEN Personal Access Token yes
NITTER_DOMAIN Nitter RSS domain no



🗞️ Subscribe OPML

For Inoreader, please see the official blog, OPML subscriptions.
For other RSS readers, please see each help page.



🆘 Help



🎽 Contributing

I happily welcome your contributions! Before you contribute, I would recommend reading CONTRIBUTING.md for a better development experience.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@5ouma/opml-generator

Import symbol

import * as opml_generator from "@5ouma/opml-generator";
or

Import directly with a jsr specifier

import * as opml_generator from "jsr:@5ouma/opml-generator";