Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
0x1eef committed Nov 17, 2024
1 parent 1f18f79 commit 3cf624b
Showing 1 changed file with 42 additions and 45 deletions.
87 changes: 42 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,51 +54,48 @@ won't need to install these tools:
# Start web server
bundle exec rake server

## Configuration

* **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 `bundle exec rake nanoc:build`.

* **audio.base_url** <br>
`audio.base_url` controls what web server serves
audio content.
[The default](https://al-quran-audio.reflectslight.io/rifai)
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-audio.reflectslight.io endpoint
provides the following recitations:

- Mishari bin Rashed Alafasy <br>
https://al-quran-audio.reflectslight.io/alafasy
- Ahmad bin Ali Al-Ajmi <br>
https://al-quran-audio.reflectslight.io/alajmi
- Sahl Yassin <br>
https://al-quran-audio.reflectslight.io/yassin
- Hani ar-Rifai <br>
https://al-quran-audio.reflectslight.io/rifai

**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-audio.reflectslight.io
instead.
### Configuration

**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 `bundle exec rake nanoc:build`.

**audio.base_url** <br>
`audio.base_url` controls what web server serves
audio content.
[The default](https://al-quran-audio.reflectslight.io/rifai)
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-audio.reflectslight.io endpoint
provides the following recitations:

- Mishari bin Rashed Alafasy <br>
https://al-quran-audio.reflectslight.io/alafasy
- Ahmad bin Ali Al-Ajmi <br>
https://al-quran-audio.reflectslight.io/alajmi
- Sahl Yassin <br>
https://al-quran-audio.reflectslight.io/yassin
- Hani ar-Rifai <br>
https://al-quran-audio.reflectslight.io/rifai

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-audio.reflectslight.io
instead.

## Credit

Expand Down

0 comments on commit 3cf624b

Please sign in to comment.