https://github.com/thepushkarp/craft-tweet-helper
A Craft Docs extension to help you write tweets in limit.
https://github.com/thepushkarp/craft-tweet-helper
craft extension tweet
Last synced: 7 months ago
JSON representation
A Craft Docs extension to help you write tweets in limit.
- Host: GitHub
- URL: https://github.com/thepushkarp/craft-tweet-helper
- Owner: thepushkarp
- License: mit
- Created: 2023-01-28T10:13:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-29T06:59:42.000Z (over 2 years ago)
- Last Synced: 2025-02-07T08:20:06.043Z (9 months ago)
- Topics: craft, extension, tweet
- Language: HTML
- Homepage:
- Size: 23.4 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Twitter Helper Craft Extension
A Craft Docs extension to help you write tweets in limit
Say goodbye to checking the character count manually and then deleting and rewriting your tweet! This extension shows you a character counter and provides a visual indicator of how many characters you have left to write your tweet in.
## Table of Contents
- [(DO THIS FIRST) Enable Craft eXtensions](#do-this-first-enable-craft-extensions)
- [Installation](#installation)
- [Install from release](#install-from-release)
- [Build from source and install](#build-from-source-and-install)
- [Usage](#usage)
- [Acknowledgements](#acknowledgements)
- [License](#license)
## (DO THIS FIRST) Enable Craft eXtensions
1. Open Craft
2. Enable eXtensions in the settings
- Mac: At the top left of the app, click your avatar, select Preferences, click Advanced. Under Craft eXtensions, click the dropdown, and select Enabled.
- Web: At the top left of the web app, click your avatar, select Craft eXtensions, toggle Craft eXtensions on.
3. At the bottom of the right side bar, the eXtensions logo is now visible. Click it to open the eXtensions panel.
## Installation
### Install from release
1. Download the latest release build file named `tweet-helper.craftx` from [here](https://github.com/thepushkarp/craft-tweet-helper/releases).
2. Click the eXtensions logo at the bottom of the right side bar of Craft page to open the eXtensions panel.
3. Click the **+** sign, select the `tweet-helper.craftx` file you just downloaded and click **Open**.
4. Click **Install**.
### Build from source and install
1. Clone the repository
```bash
git clone https://github.com/thepushkarp/craft-tweet-helper.git
```
2. Build the extension
```bash
zip -vr tweet-helper.craftx icon.png index.html manifest.json
```
A file named `tweet-helper.craftx` will be created.
3. Install the extension
- Click the eXtensions logo at the bottom of the right side bar of Craft page to open the eXtensions panel.
- Click the **+** sign, select the `tweet-helper.craftx` file created in the last step and click **Open**.
- Click **Install**.
## Usage
1. Open a new Craft document or open an existing document.
2. Select the text you want to tweet. **Please note that the text should be in a single block to be identified correctly.**
3. Click the eXtensions logo at the bottom of the right side bar of Craft page to open the eXtensions panel and click the **Tweet Helper** extension.
4. The extension will show you a visual indicator of how many characters you have left to write your tweet in.
## Acknowledgements
- [Twitter Logo](https://github.com/thepushkarp/craft-tweet-helper/blob/main/icon.png) from [Twitter Brand Guidelines](https://about.twitter.com/en/who-we-are/brand-toolkit)
- [Craft Extension Guide](https://www.craft.do/s/OhmDYXrBwI2wZS)
## License
[MIT](https://github.com/thepushkarp/craft-tweet-helper/blob/main/LICENSE)
Made with ❤️ by Pushkar Patel