https://github.com/5ouma/opml-generator

📰 Generate OPML file via TOML file easily
https://github.com/5ouma/opml-generator

gist github-actions jsr opml rss toml

Last synced: 2 months ago
JSON representation

📰 Generate OPML file via TOML file easily

• Host: GitHub
• URL: https://github.com/5ouma/opml-generator
• Owner: 5ouma
• License: mit
• Created: 2024-02-14T08:30:12.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T02:44:21.000Z (3 months ago)
• Last Synced: 2024-09-19T05:27:33.885Z (3 months ago)
• Topics: gist, github-actions, jsr, opml, rss, toml
• Language: TypeScript
• Homepage: https://jsr.io/@5ouma/opml-generator
• Size: 195 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
OPML Generator




**📰 Generate OPML file via TOML file easily**

[![GitHub Release](https://img.shields.io/github/v/release/5ouma/opml-generator?style=flat-square)](https://github.com/5ouma/opml-generator/releases)

[![JSR](https://jsr.io/badges/@5ouma/opml-generator?style=flat-square)](https://jsr.io/@5ouma/opml-generator)

[![JSR Score](https://jsr.io/badges/@5ouma/opml-generator/score)](https://jsr.io/@5ouma/opml-generator)




![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/5ouma/opml-generator?style=flat-square)

![GitHub repo size](https://img.shields.io/github/repo-size/5ouma/opml-generator?style=flat-square)

[![GitHub last commit](https://img.shields.io/github/last-commit/5ouma/opml-generator?style=flat-square)](https://github.com/5ouma/opml-generator/commit/HEAD)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/5ouma/opml-generator?style=flat-square)](https://github.com/5ouma/opml-generator/commits/main)




[![CI](https://img.shields.io/github/actions/workflow/status/5ouma/opml-generator/ci.yml?label=ci&style=flat-square)](https://github.com/5ouma/opml-generator/actions/workflows/ci.yml)

[![Release](https://img.shields.io/github/actions/workflow/status/5ouma/opml-generator/release.yml?label=release&style=flat-square)](https://github.com/5ouma/opml-generator/actions/workflows/release.yml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/5ouma/opml-generator/main.svg?style=flat-square)](https://results.pre-commit.ci/latest/github/5ouma/opml-generator/main)

[![codecov](https://codecov.io/github/5ouma/opml-generator/graph/badge.svg?token=ICJ7C3IDX7)](https://codecov.io/github/5ouma/opml-generator)







## 📊 Usage

OPML Generator has 2 ways to convert TOML to OPML.

### 💻 On Local

1. Prepare your TOML file (Reference:

   [feeds.toml](./.github/assets/example/feeds.toml))

2. Run this command

   ```she

   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](https://gist.github.com):

   - includes [`feeds.toml`](./.github/assets/example/feeds.toml)

   - for outputs

2. Prepare your repository to run

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

   sidebar

   > [🌍 Environment Variables](#-environment-variables)

4. Add [`gist-update.yml`](./.github/workflows/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            |

[`feeds.toml`]: ./assets/example/feeds.toml

[Personal Access Token]: https://github.com/settings/tokens/new?description=OPML%20Generator&scopes=gist





## 🗞️ Subscribe OPML

For Inoreader, please see the official blog,

[**OPML subscriptions**](https://www.inoreader.com/blog/2014/05/opml-subscriptions.html).


 For other RSS readers, please see each help page.





## 🆘 Help

- [**⚠️ Issues**]: Feature Requests or Bug Reports

- [**💬 Discussions**]: General Chats or Questions

- [**🛡️ Security Advisories**]: Security Issues that should not be public

[**⚠️ Issues**]: https://github.com/5ouma/opml-generator/issues/new/choose

[**💬 Discussions**]: https://github.com/5ouma/opml-generator/discussions/new/choose

[**🛡️ Security Advisories**]: https://github.com/5ouma/opml-generator/security/advisories/new





## 🎽 Contributing

I happily welcome your contributions! Before you contribute, I would recommend

reading [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for a better development

experience.