ReflectsLight/al-quran.reflectslight.io
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update
Some checks are pending
The Quran / ci (push) Waiting to run
Details

Browse source
This commit is contained in:
0x1eef 2024-11-16 23:00:33 -03:00
parent 1f18f792b4
commit 3cf624b4c0
1 changed files with 37 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -54,51 +54,48 @@ won't need to install these tools:
# Start web server # Start web server
bundle exec rake server bundle exec rake server
## Configuration ### Configuration
* **server.base_url** <br> **server.base_url** <br>
If you plan to host the website on If you plan to host the website on
your own domain you should update your own domain you should update
[nanoc.yaml](nanoc.yaml.sample) [nanoc.yaml](nanoc.yaml.sample)
first. In certain places first. In certain places links will reference
links will reference https://al-quran.reflectslight.io
https://al-quran.reflectslight.io instead of using a relative path. For example
instead of using a relative path. [/src/sitemap.xml.erb](/src/sitemap.xml.erb)
For example is one such place. Those links can be updated
[/src/sitemap.xml.erb](/src/sitemap.xml.erb) to your own domain by changing the `server.base_url`
is one such place. Those links can be updated field in
to your own domain by changing the `server.base_url` [nanoc.yaml](nanoc.yaml.sample)
field in before running `bundle exec rake nanoc:build`.
[nanoc.yaml](nanoc.yaml.sample)
before running `bundle exec rake nanoc:build`.
* **audio.base_url** <br> **audio.base_url** <br>
`audio.base_url` controls what web server serves `audio.base_url` controls what web server serves
audio content. audio content.
[The default](https://al-quran-audio.reflectslight.io/rifai) [The default](https://al-quran-audio.reflectslight.io/rifai)
works out of the box. The URL for an audio file is works out of the box. The URL for an audio file is
resolved by joining `audio.base_url` and resolved by joining `audio.base_url` and
`/<surahid>/<ayahid>.mp3`. The `audio.base_url` option `/<surahid>/<ayahid>.mp3`. The `audio.base_url` option
makes it relatively easy to change the reciter makes it relatively easy to change the reciter
at build time, before deploying the website. at build time, before deploying the website.
The https://al-quran-audio.reflectslight.io endpoint The https://al-quran-audio.reflectslight.io endpoint
provides the following recitations: provides the following recitations:
- Mishari bin Rashed Alafasy <br> - Mishari bin Rashed Alafasy <br>
https://al-quran-audio.reflectslight.io/alafasy https://al-quran-audio.reflectslight.io/alafasy
- Ahmad bin Ali Al-Ajmi <br> - Ahmad bin Ali Al-Ajmi <br>
https://al-quran-audio.reflectslight.io/alajmi https://al-quran-audio.reflectslight.io/alajmi
- Sahl Yassin <br> - Sahl Yassin <br>
https://al-quran-audio.reflectslight.io/yassin https://al-quran-audio.reflectslight.io/yassin
- Hani ar-Rifai <br> - Hani ar-Rifai <br>
https://al-quran-audio.reflectslight.io/rifai https://al-quran-audio.reflectslight.io/rifai
**Note**<br> Due to their overall size the audio files are the only
Due to their overall size the audio files are the only files **not** kept in this repository. The audio files
files **not** kept in this repository. The audio files are hosted by https://al-quran-audio.reflectslight.io
are hosted by https://al-quran-audio.reflectslight.io instead.
instead.
## Credit ## Credit