Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javadr/gedit-quran
Typeset quran text in gedit
https://github.com/javadr/gedit-quran
Last synced: 6 days ago
JSON representation
Typeset quran text in gedit
- Host: GitHub
- URL: https://github.com/javadr/gedit-quran
- Owner: javadr
- Created: 2023-12-18T09:24:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-05-06T21:28:51.000Z (7 months ago)
- Last Synced: 2024-05-06T22:33:47.849Z (7 months ago)
- Language: Python
- Size: 688 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gedit-quran
This plugin facilitates the accurate typesetting of Holy Quran verses within the gedit text editor.
## Installation
### Option 1: Quick Install
Run the following command in your terminal:
```sh
git clone https://github.com/javadr/gedit-quran.git; cd gedit-quran
make install
```
### Option 2: Manual Installation
Download the ZIP file and move the extracted files to your `gedit` plugin directory (usually located at `~/.local/share/gedit/plugins/`), or clone the repository using Git:
```sh
mkdir -p ~/.local/share/gedit/plugins
git clone https://github.com/javadr/gedit-quran.git
cp -rfv gedit-quran/src/* ~/.local/share/gedit/plugins
```
## Usage
After restarting Gedit and activating the plugin from the preferences dialog,
you can seamlessly access it in two ways:
1. **Via Tools Menu:**
Navigate to the `Tools` menu, where you'll find the plugin conveniently listed.
Click on `Quran...` to start using the features.
2. **Shortcut Key:**
Use the shortcut ` + q` to quickly access the plugin without navigating through menus.
Enjoy typesetting Quranic verses in your `gedit` editor!
## Options
The `gedit-quran` plugin offers several customization options to tailor your experience:
1. **Ayah Number:** Appends the Ayah number to the end of each Ayah.
2. **NewLine Character:** Typesets each Ayah on a separate line for improved readability.
3. **LaTeX Integration:** Utilizes the `LaTeX` command to incorporate the `LaTeX` macro, in conjunction with the [quran](https://github.com/javadr/quran) LaTeX package.
4. **Tanzil Integration:** Opens the specified Ayah in [Tanzil.net](https://tanzil.net).
## Contributing
Feel free to contribute by opening issues or submitting pull requests.
We welcome your feedback!