Skip to content

Commit 1d1809b

Browse files
authored
Merge pull request #5 from UrbanMonastics/main
Bring up version 0.3 to the release branch.
2 parents 3583b28 + f424ca5 commit 1d1809b

13 files changed

+359
-34
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,19 @@ The source texts use a subset of the Markdown functionality, and include some ad
1010

1111
## Features
1212

13-
* One File without any Dependencies
14-
* Fast
15-
* Extended to support Liturgical needs
16-
* [GitHub flavored](https://github.github.com/gfm)
13+
* Fast
14+
* No external dependancies.
15+
* Built with multibyte text encoding in mind.
16+
* Extended to support Liturgical needs - enable what you need
17+
* Including Versicals
18+
* Including inline Crosses, Pauses, and Daggers
19+
* Including Intercessory prayers. With an introduction, response, and two part intentions
20+
* Including Small Caps of words over 3 characters [enable seperate]
21+
* Including wrapping the term Selah for custom styling [enable seperate]
22+
* Including suppression of the term Alleluia (definable in your language) [enable seperate]
23+
* Including inline red letter text.
24+
* Supports overlined text for more robust manuscript support.
25+
* [GitHub flavored](https://github.github.com/gfm)
1726
* [Tested](http://parsedown.org/tests/) in 7.0 to 8.0
1827

1928
## Extending Markdown
@@ -97,12 +106,16 @@ These texts may need to be used in various formats and contexts. There are going
97106
When enabled it will convert inline URL strings into clickable links.
98107
* **setPreserveIndentations( *bool* )** default: false
99108
When enabled this will convert any tabs (set of 4 spaces) into four double spaces wrapped in a span. Enabling this will disable tabbing for code blocks.
100-
* **setLiturgicalElements( *bool* )** default: false
109+
* **setLiturgicalElements( *bool* )** default: true
101110
When enabled the standard Markdown will be supplemented with liturgical elements. See Extending Markdown above for additions
102111
* **setLiturgicalHTML( *bool* )** default: true
103112
Do we place liturgical markers within HTML tags, or just place them directly into the document.
104-
* **setSuppressAlleluia( *bool* )** default: false
105-
During the season of Lent the use of the word Alleluia is suppressed. Enabling this option will remove any line where the only text is the word Alleluia.
113+
* **setSelahHTML( *bool*, *string SelahTerm* )** default: false, selah
114+
Do we wrap the term Selah in html for easier styling. The Selah term is optional, and allows you to indicated terms used in other languages.
115+
* **setSmallCapsText( *bool* )**
116+
Will look for any words of three characters or longer with every character capitolized. These words will then be wrapped in HTML for converting to small caps. This is done in some biblical texts to indicate when the term "יְהֹוָה" (or yhwh) is used to reference God.
117+
* **setSuppressAlleluia( *bool*, *string AlleluiaTerm* )** default: false, Alleluia
118+
During the season of Lent the use of the word Alleluia is suppressed. Enabling this option will remove any line where the only text is the word Alleluia. You may also define the alleluia term to look for in the texts for broader language support.
106119
* **setTitlesEnabled( *bool* )** default: false
107120
Do we place any titles from the `text.json` document into the output
108121
* **setFootnotesEnabled( *bool* )** default: false

0 commit comments

Comments
 (0)