ReflectsLight/al-quran.reflectslight.io
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
al-quran.reflectslight.io/README.md
0x1eef 6e1a7aec51 Add Nanoc::Filters::Tidy 
Add a nanoc filter that runs HTML content through
[tidy-html](https://github.com/htacg/tidy-html5).

The content that is first run through ERB is often indented
incorrectly and inconsistently, and 'tidy' can fix that for us.
2023-10-07 19:29:52 -03:00

1.7 KiB
Raw Blame History

About

This repository contains the source code of al-quran.reflectslight.io, a static website for reading The Quran. After the website is built, the build directory consists of HTML, CSS, JavaScript and other static assets that can be hosted by a regular web server (eg nginx, apache, etc).

The stack

The following languages and tools have to be installed before the website can be built:

  • Ruby 3.1, or later.
  • NodeJS v18.15, or later.
  • tidy-html5
    There is a good chance there's a package available for tidy-html5 on your operating system of choice.

Local development

1. Clone

git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran

2. Install Ruby, NodeJS packages

bundle install
npm i

3. Build website

# Build once
rake build

# Build whenever a change is detected
rake build:watch

4. Start server on localhost

rake server

Thanks

First and foremost, Alhamdulillah.