https://github.com/piterden/syntax-highlighter-bot

Syntax highlighter bot for telegram.
https://github.com/piterden/syntax-highlighter-bot

bot nodejs syntax-highlighting telegraf telegram

Last synced: 3 months ago
JSON representation

Syntax highlighter bot for telegram.

• Host: GitHub
• URL: https://github.com/piterden/syntax-highlighter-bot
• Owner: Piterden
• Created: 2017-11-27T23:50:43.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T08:28:42.000Z (almost 2 years ago)
• Last Synced: 2024-06-19T03:02:49.874Z (8 months ago)
• Topics: bot, nodejs, syntax-highlighting, telegraf, telegram
• Language: JavaScript
• Homepage: https://t.me/cris_highlight_bot
• Size: 851 KB
• Stars: 70
• Watchers: 3
• Forks: 13
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Syntax Highlighter Bot

![Travis (.org)](https://img.shields.io/travis/com/Piterden/syntax-highlighter-bot.svg?style=for-the-badge) ![GitHub search hit counter](https://img.shields.io/github/search/Piterden/syntax-highlighter-bot/highlight.svg?style=for-the-badge) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Piterden/syntax-highlighter-bot.svg?style=for-the-badge)

The bot for creating an image with highlighted code from a message.

## Overview

This bot was written on top of the [Telegraf.js](https://github.com/telegraf/telegraf) bot framework, so all you need to have is the Node.js > v6.

## Usage

[Demo](https://t.me/cris_highlight_bot) (WIP version).

The bot listens for entities type of `pre` in any text message. It means, it will render all pieces of text, wrapped in triple backticks (multiline code). Also you could force the language, writing its name on the first line, right after backticks. Just like on the GitHub.

Look at the example of a code should be handled by the bot:

```

\`\`\`js

/**

 * Show themes list

 */

bot.command('theme', (ctx) => isPrivateChat(ctx)

  ? ctx.replyWithMarkdown(

    messages.themeChoose(ctx.state.user.theme),

    Markup.keyboard(themesKeyboard(themes)).oneTime().resize().extra()

  )

  : ctx.reply(messages.themeGroup)

)\`\`\`

```

### Commands

- `/start` - Initial launch of the bot.

- `/theme` - Shows the list of included themes and allows you to select a theme which you like more.

- `/langs` - Shows the list of supported languages.

## Installing

First of all clone this repository and install dependencies. Run in the terminal:

```bash

$ git clone [email protected]:Piterden/syntax-highlighter-bot.git

$ cd syntax-highlighter-bot

$ npm i

```

Then you need to create and fill the new `.env` file:

```bash

$ cp .env.example .env

$ editor .env

```

## Built With

* [Telegraf.js](https://github.com/telegraf/telegraf) - The bot framework.

* [Objection.js](http://vincit.github.io/objection.js/) - ORM.

* [Express.js](https://expressjs.com/) - HTTP server.

* [Knex.js](http://knexjs.org/) - Query builder.

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Authors

* **Cristian Ospina** - *Bot's [initial version](https://github.com/Piterden/syntax-highlighter-bot/tree/old-double-bot)* - [CristianOspina](https://github.com/CristianOspina)

* **Denis Efremov** - *Rewrite to the Node.js* - [Piterden](https://github.com/Piterden)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Donate

- **BTC** `3F275vPSCvYW19MHZqSjw79fEwwU4MbTgV`

- **LTC** `MGMCQB3QAcrSBjU3eGJviqB2J2f5BNVRGr`

- **DOGE** `D5m69FRDGEn3G3xuakvqTxUpGVt6NegKJp`