Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hatamiarash7/tg-blog-updater
Update Jekyll blog using Telegram
https://github.com/hatamiarash7/tg-blog-updater
jekyll jekyll-ecosystem telegram telegram-bot
Last synced: 17 days ago
JSON representation
Update Jekyll blog using Telegram
- Host: GitHub
- URL: https://github.com/hatamiarash7/tg-blog-updater
- Owner: hatamiarash7
- License: mit
- Created: 2024-03-14T08:57:14.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-02T06:13:17.000Z (about 1 month ago)
- Last Synced: 2024-10-03T16:40:14.887Z (about 1 month ago)
- Topics: jekyll, jekyll-ecosystem, telegram, telegram-bot
- Language: Python
- Homepage:
- Size: 145 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Update Jekyll blog using Telegram
[](https://www.python.org/) [](https://GitHub.com/hatamiarash7/tg-blog-updater/releases/) [](https://github.com/hatamiarash7/tg-blog-updater/actions/workflows/release.yml) 
It's a simple Telegram bot to read messages and update a Jekyll blog.
1. Read messages from a Telegram group, channel or direct chat.
2. Parse the message and extract metadata and content.
3. Create a new post in the Jekyll blog using Github's API.
4. Deploy new changes using your CI/CD pipeline *(It is up to you to implement this)*.
## How to use it
1. Create a new bot using BotFather and get the token.
2. Create a new Github token with `repo` scope.
3. Run the bot using the following environment variables:
- `TELEGRAM_TOKEN`: The token of your bot
- `CHAT_ID`: A chat id that the bot should listen to. It can be a group, channel or a direct chat.
- `DEBUG_CHAT_ID`: A chat id to send debug messages (For example, you can get all errors in your private chat)
- `GITHUB_TOKEN`: The token to access the Github API.
- `GITHUB_REPO_NAME`: The name of the repository with the format `username/repo`.
- `POST_PATH`: The target path to create the new post. For Jekyll blogs, it is `_posts`.
> [!TIP]
> You can use `TELEGRAM_BASE_URL` environment variable to change the base URL of the Telegram API.
```bash
docker run -d --name jekyll-telegram-bot \
-e TELEGRAM_TOKEN=your-telegram-token \
-e CHAT_ID=your-chat-id \
-e DEBUG_CHAT_ID=your-chat-id \
-e GITHUB_TOKEN=your-github-token \
-e GITHUB_REPO_NAME=your-username/your-repo \
-e POST_PATH=_posts \
hatamiarash7/tg-blog-updater:v1.0.1
```
## Message format
There is a default format to create a new post. The bot will parse the message and create a new post using the following format:
```text
title
===
tags ( comma separated )
===
content
```
For example:
```text
Hello world
===
jekyll,telegram,blog
===
This is the content of the post
```
> [!NOTE]
> You should change the code if you want to use a different format.
---
## Support 💛
[](https://donatebadges.ir/donate/Bitcoin/bc1qmmh6vt366yzjt3grjxjjqynrrxs3frun8gnxrz) [](https://donatebadges.ir/donate/Ethereum/0x0831bD72Ea8904B38Be9D6185Da2f930d6078094)
## Contributing 🤝
Don't be shy and reach out to us if you want to contribute 😉
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
## Issues
Each project may have many problems. Contributing to the better development of this project by reporting them. 👍