Update README

This commit is contained in:
0x1eef 2024-08-12 17:52:58 -03:00
parent a7767b9f68
commit da59075400

View file

@ -17,11 +17,6 @@ installed to build the website from source:
* NodeJS v18.15 (or later) * NodeJS v18.15 (or later)
* [tidy-html5](https://github.com/htacg/tidy-html5) * [tidy-html5](https://github.com/htacg/tidy-html5)
**Please note** that the audio files are hosted by
https://al-quran.reflectslight.io, and due to
their overall size they are only files **not**
kept in this repository.
## Development ## Development
# Clone repository # Clone repository
@ -45,59 +40,58 @@ kept in this repository.
## Configuration ## Configuration
**server.base_url** * **server.base_url** <br>
If you plan to host the website on
your own domain you should update
[nanoc.yaml](nanoc.yaml.sample)
first. In certain places
links will reference
https://al-quran.reflectslight.io
instead of using a relative path.
For example
[/src/sitemap.xml.erb](/src/sitemap.xml.erb)
is one such place. Those links can be updated
to your own domain by changing the `server.base_url`
field in
[nanoc.yaml](nanoc.yaml.sample)
before running `rake nanoc:build`.
If you plan to host the website on * **audio.base_url** <br>
your own domain you should update `audio.base_url` controls what web server serves
[nanoc.yaml](nanoc.yaml.sample) audio content.
first. In certain places [The default](https://al-quran.reflectslight.io/audio/alafasy)
links will reference works out of the box. The URL for an audio file is
https://al-quran.reflectslight.io resolved by joining `audio.base_url` and
instead of using a relative path. `/<surahid>/<ayahid>.mp3`. The `audio.base_url` option
For example makes it relatively easy to change the reciter
[/src/sitemap.xml.erb](/src/sitemap.xml.erb) at build time, before deploying the website.
is one such place. Those links can be updated
to your own domain by changing the `server.base_url`
field in
[nanoc.yaml](nanoc.yaml.sample)
before running `rake nanoc:build`.
**audio.base_url** The https://al-quran.reflectslight.io web server
provides the following recitations:
`audio.base_url` controls what web server serves - Mishari bin Rashed Alafasy <br>
audio content. The default
(https://al-quran.reflectslight.io/audio/alafasy)
works out of the box. The URL for an audio file is
resolved by joining `audio.base_url` and
`/<surahid>/<ayahid>.mp3`. The `audio.base_url` option
makes it relatively easy to change the reciter
at build time, before deploying the website.
The https://al-quran.reflectslight.io web server
provides the following recitations:
- Mishari bin Rashed Alafasy <br>
https://al-quran.reflectslight.io/audio/alafasy https://al-quran.reflectslight.io/audio/alafasy
- Ahmad bin Ali Al-Ajmi <br>
- Ahmad bin Ali Al-Ajmi <br>
https://al-quran.reflectslight.io/audio/alajmi https://al-quran.reflectslight.io/audio/alajmi
- Sahl Yassin <br>
- Sahl Yassin <br>
https://al-quran.reflectslight.io/audio/yassin https://al-quran.reflectslight.io/audio/yassin
**Note**<br>
Due to their overall size the audio files are the only
files **not** kept in this repository. The audio files
are hosted by https://al-quran.reflectslight.io instead.
## Thanks ## Thanks
Alhamdulillah الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ
* Thanks to the graphic artists: * Thanks to the graphic artists:
- [RefreshIcon](/src/js/components/Icon.tsx) - [RefreshIcon](/src/js/components/Icon.tsx)
by by
[Muhammad Haq](https://freeicons.io/profile/823) [Muhammad Haq](https://freeicons.io/profile/823)
* Thanks to the translators: * Thanks to the translators:
- English (The Clear Quran) by Dr. Mustafa Khattab - English (The Clear Quran) by Dr. Mustafa Khattab
- Farsi by Hussain Ansarian - Farsi by Hussain Ansarian
* Thanks to the reciters: * Thanks to the reciters:
- Mishari bin Rashed Alafasy - Mishari bin Rashed Alafasy
- Ahmad bin Ali Al-Ajmi - Ahmad bin Ali Al-Ajmi