Documentation Index Fetch the complete documentation index at: https://mintlify.com/ragaeeb/shamela/llms.txt
Use this file to discover all available pages before exploring further.
Overview These functions provide low-level HTML processing utilities for working with Shamela content. They handle line ending normalization, HTML tag stripping, hadeeth tag normalization, and content positioning.
normalizeLineEndings() Normalizes line endings to Unix-style (\n).
Signature normalizeLineEndings ( content : string ): string
Parameters Raw content with potentially mixed line endings
Returns Content with all line endings normalized to \n
Behavior
Converts Windows (\r\n) line endings to Unix (\n)
Converts old Mac (\r) line endings to Unix (\n)
Optimized: only processes if content contains \r
Ensures consistent pattern matching across platforms
Example import { normalizeLineEndings } from 'shamela' ; const windowsText = 'Line 1 \r\n Line 2 \r\n Line 3' ; const normalized = normalizeLineEndings ( windowsText ); console . log ( normalized ); // "Line 1\nLine 2\nLine 3"
Strips all HTML tags from content, keeping only text.
Signature stripHtmlTags ( html : string ): string
Parameters Returns Plain text content with all HTML tags removed
Example import { stripHtmlTags } from 'shamela' ; const html = '<span data-type="title">العنوان</span><p>النص</p>' ; const text = stripHtmlTags ( html ); console . log ( text ); // "العنوانالنص"
normalizeHtml() Normalizes Shamela HTML for CSS styling by converting hadeeth tags to standard span elements.
Signature normalizeHtml ( html : string ): string
Parameters Returns HTML with normalized hadeeth tags
<hadeeth-N> → <span class="hadeeth"></hadeeth> → </span><hadeeth> → </span>
Example import { normalizeHtml } from 'shamela' ; const html = '<hadeeth-1>متن الحديث</hadeeth>' ; const normalized = normalizeHtml ( html ); console . log ( normalized ); // => '<span class="hadeeth">متن الحديث</span>'
Use Case Prepare Shamela HTML for browser rendering with CSS:
import { normalizeHtml } from 'shamela' ; const displayHtml = normalizeHtml ( rawContent ); // Now you can style .hadeeth spans with CSS
.hadeeth { background-color : #f0f0f0 ; padding : 0.5 rem ; border-left : 3 px solid #333 ; }
normalizeTitleSpans() Normalizes consecutive Shamela-style title spans to prevent multiple headings on one line.
Signature normalizeTitleSpans ( html : string , options : NormalizeTitleSpanOptions ): string
Parameters HTML content with title spans
options
NormalizeTitleSpanOptions
required
Configuration for handling consecutive title spans Show NormalizeTitleSpanOptions properties
strategy
'splitLines' | 'merge' | 'hierarchy'
required
How to handle adjacent title spans:
splitLines: Insert \n between spans (recommended)merge: Combine into single span with separatorhierarchy: Convert subsequent spans to data-type="subtitle" Used only for merge strategy
Returns HTML with normalized title spans
Problem Shamela exports sometimes contain adjacent title spans:
< span data-type = "title" > باب الميم </ span >< span data-type = "title" > من اسمه محمد </ span >
Converting each to markdown produces: ## باب الميم ## من اسمه محمد
Solutions splitLines Strategy (Recommended) import { normalizeTitleSpans } from 'shamela' ; const html = '<span data-type="title">A</span><span data-type="title">B</span>' ; const normalized = normalizeTitleSpans ( html , { strategy: 'splitLines' }); // => '<span data-type="title">A</span>\n<span data-type="title">B</span>'
merge Strategy const normalized = normalizeTitleSpans ( html , { strategy: 'merge' , separator: ' — ' , }); // => '<span data-type="title">A — B</span>'
hierarchy Strategy const normalized = normalizeTitleSpans ( html , { strategy: 'hierarchy' }); // => '<span data-type="title">A</span>\n<span data-type="subtitle">B</span>'
moveContentAfterLineBreakIntoSpan() Moves content that appears after a line break but before a title span into the span.
Signature moveContentAfterLineBreakIntoSpan ( html : string ): string
Parameters HTML content with potential pre-title text
Returns HTML with pre-title text moved inside title spans
Problem Chapter numbers or prefixes are sometimes placed outside the title span:
\r١ - < span data-type = "title" > الباب الأول </ span >
Solution import { moveContentAfterLineBreakIntoSpan } from 'shamela' ; const html = ' \r ١ - <span data-type="title">الباب الأول</span>' ; const fixed = moveContentAfterLineBreakIntoSpan ( html ); // => '\r<span data-type="title">١ - الباب الأول</span>'
Use Case Ensure chapter numbers are included in title extraction:
import { moveContentAfterLineBreakIntoSpan , parseContentRobust , } from 'shamela' ; let html = rawContent ; html = moveContentAfterLineBreakIntoSpan ( html ); const lines = parseContentRobust ( html ); // Now chapter numbers are included in title text lines . forEach ( line => { if ( line . id ) { console . log ( `Title: ${ line . text } ` ); // Includes "١ - " } });