Obsidian - The Quran Vault

Introduction

This repository contains an Obsidian vault that houses the complete Quran, with each surah in a separate file.

Requirements

• Obsidian

Installation

• Go to the release page and download the latest version of the vault.
• Extract the downloaded file into your vault folder.
• Make sure that The Quran folder and the .obsidian/snippets/quran.css file exists.
• Open Obsidian and enable the CSS snippet file:
  • Go to Settings > Appearance > Scroll to the bottom > enable the quran option.

Features

• Surah Separation: Each surah is contained in a separate file, making it easy to navigate.
• Markdown Format: The Quranic presented in markdown format, allowing for easy reading and annotation in Obsidian.
• Searching Ability: Tags for every surah making it easy to search.

Acknowledgments

• Quran text collection made possible with the help of PyQuran, a Python library for Quranic text retrieval.

Contributing

If you would like to contribute to this project, feel free to fork the repository and submit a pull request. Whether it's fixing a bug, adding new features, or improving documentation, contributions are always welcome!

License

This Obsidian vault is licensed under the MIT License, allowing for free use and distribution.

Authors

• Mohammed Khalid ilordyyyyy@gmail.com
• Mohammed Reda