From 3cf624b4c0cf4bf4430c1becfd43d111991a683b Mon Sep 17 00:00:00 2001 From: 0x1eef <0x1eef@protonmail.com> Date: Sat, 16 Nov 2024 23:00:33 -0300 Subject: [PATCH] docs: update --- README.md | 77 ++++++++++++++++++++++++++----------------------------- 1 file changed, 37 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 539a560..f531fa4 100644 --- a/README.md +++ b/README.md @@ -54,51 +54,48 @@ won't need to install these tools: # Start web server bundle exec rake server -## Configuration +### Configuration -* **server.base_url**
- 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`. +**server.base_url**
+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**
- `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 - `//.mp3`. The `audio.base_url` option - makes it relatively easy to change the reciter - at build time, before deploying the website. +**audio.base_url**
+`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 +`//.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: +The https://al-quran-audio.reflectslight.io endpoint +provides the following recitations: - - Mishari bin Rashed Alafasy
- https://al-quran-audio.reflectslight.io/alafasy - - Ahmad bin Ali Al-Ajmi
- https://al-quran-audio.reflectslight.io/alajmi - - Sahl Yassin
- https://al-quran-audio.reflectslight.io/yassin - - Hani ar-Rifai
- https://al-quran-audio.reflectslight.io/rifai +- Mishari bin Rashed Alafasy
+ https://al-quran-audio.reflectslight.io/alafasy +- Ahmad bin Ali Al-Ajmi
+ https://al-quran-audio.reflectslight.io/alajmi +- Sahl Yassin
+ https://al-quran-audio.reflectslight.io/yassin +- Hani ar-Rifai
+ https://al-quran-audio.reflectslight.io/rifai - **Note**
- 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. +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