Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 4.11 KB

README.md

File metadata and controls

103 lines (68 loc) · 4.11 KB

OPML Generator

📰 Generate OPML file via TOML file easily

GitHub Release JSR JSR Score
GitHub code size in bytes GitHub repo size GitHub last commit GitHub commit activity
CI Release pre-commit codecov



📊 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.