slick 1.1.1.0 → 1.1.2.0
raw patch · 4 files changed
+69/−7 lines, 4 filesPVP ok
version bump matches the API change (PVP)
API changes (from Hackage documentation)
+ Slick: orgModeToHTML :: Text -> Action Value
+ Slick.Pandoc: defaultOrgModeOptions :: ReaderOptions
+ Slick.Pandoc: orgModeToHTML :: Text -> Action Value
+ Slick.Pandoc: orgModeToHTML' :: FromJSON a => Text -> Action a
+ Slick.Pandoc: orgModeToHTMLWithOpts :: ReaderOptions -> WriterOptions -> Text -> Action Value
+ Slick.Pandoc: orgModeToHTMLWithOpts' :: FromJSON a => ReaderOptions -> WriterOptions -> Text -> Action a
Files
- ChangeLog.md +8/−2
- slick.cabal +3/−3
- src/Slick.hs +1/−0
- src/Slick/Pandoc.hs +57/−2
ChangeLog.md view
@@ -1,10 +1,16 @@ # Changelog for slick -## 1.1.0.0-- Upgrade to lts-16.29+## 1.1.2.0+- Upgrade to lts-18.9 and add support for org-mode documents. +## 1.1.1.1+- Upgrade to lts-17.8 and ghc-8.10.4+ ## 1.1.1.0 - Add `loadUsingMeta` to allow specifying a separate pandoc meta writer.++## 1.1.0.0+- Upgrade to lts-16.29 ## 1.0.1.0 - Add `makePandocReaderWithMetaWriter` and `makePandocReaderWithMetaWriter'` for reading in resources with custom Pandoc Writers for metadata.
slick.cabal view
@@ -1,13 +1,13 @@ cabal-version: 1.12 --- This file has been generated from package.yaml by hpack version 0.33.0.+-- This file has been generated from package.yaml by hpack version 0.34.4. -- -- see: https://github.com/sol/hpack ----- hash: ed2daf4cedbda6a1a41895f4c176fa62e5966613f2e5de2999685f0939e51627+-- hash: 3ce71611de676254e3f2d771e29b65392e51071f726b0ac34b79222d719090b6 name: slick-version: 1.1.1.0+version: 1.1.2.0 synopsis: A quick & easy static site builder built with shake and pandoc. description: Please see the README on GitHub at <https://github.com/ChrisPenner/slick#readme> category: Web
src/Slick.hs view
@@ -17,6 +17,7 @@ , slickWithOpts , markdownToHTML , markdownToHTML'+ , orgModeToHTML -- ** Mustache Templating , compileTemplate'
src/Slick/Pandoc.hs view
@@ -11,6 +11,10 @@ , markdownToHTML' , markdownToHTMLWithOpts , markdownToHTMLWithOpts' + , orgModeToHTML+ , orgModeToHTML'+ , orgModeToHTMLWithOpts+ , orgModeToHTMLWithOpts' , makePandocReader , makePandocReader' , makePandocReaderWithMetaWriter@@ -20,6 +24,7 @@ , loadUsing , loadUsing' , defaultMarkdownOptions+ , defaultOrgModeOptions , defaultHtml5Options , convert , flattenMeta@@ -61,6 +66,17 @@ , writerExtensions = writerExtensions def } +-- | Reasonable options for reading an org-mode file+defaultOrgModeOptions :: ReaderOptions+defaultOrgModeOptions =+ def { readerExtensions = exts }+ where+ exts = mconcat+ [ extensionsFromList+ [ Ext_fenced_code_attributes+ , Ext_auto_identifiers+ ]+ ] -------------------------------------------------------------------------------- -- | Handle possible pandoc failure within the Action Monad@@ -86,7 +102,7 @@ markdownToHTML' txt = markdownToHTML txt >>= convert --- | Like 'markdownToHTML' but allows returning any JSON serializable object+-- | Like 'markdownToHTML' but allows providing additional pandoc reader and writer options markdownToHTMLWithOpts :: ReaderOptions -- ^ Pandoc reader options to specify extensions or other functionality -> WriterOptions -- ^ Pandoc writer options to modify output@@ -98,7 +114,7 @@ (writeHtml5String wops) txt --- | Like 'markdownToHTML' but allows returning any JSON serializable object+-- | Like 'markdownToHTMLWithOpts' but returns any JSON serializable object. markdownToHTMLWithOpts' :: (FromJSON a) => ReaderOptions -- ^ Pandoc reader options to specify extensions or other functionality@@ -107,6 +123,45 @@ -> Action a markdownToHTMLWithOpts' rops wops txt = markdownToHTMLWithOpts rops wops txt >>= convert++-- | Convert org-mode text into a 'Value';+--+-- The 'Value' has a "content" key containing rendered HTML.+--+-- Metadata is assigned on the respective keys in the 'Value'+orgModeToHTML :: T.Text+ -> Action Value+orgModeToHTML txt =+ orgModeToHTMLWithOpts defaultOrgModeOptions defaultHtml5Options txt++-- | Like 'orgModeToHTML' but allows returning any JSON compatible object.+orgModeToHTML' :: (FromJSON a)+ => T.Text+ -> Action a+orgModeToHTML' txt =+ orgModeToHTML txt >>= convert++-- | Like 'orgModeToHTML' but allows providing additional pandoc reader and writer options+orgModeToHTMLWithOpts+ :: ReaderOptions -- ^ Pandoc reader options to specify extensions or other functionality+ -> WriterOptions -- ^ Pandoc writer options to modify output+ -> T.Text -- ^ Text for conversion+ -> Action Value+orgModeToHTMLWithOpts rops wops txt =+ loadUsing+ (readOrg rops)+ (writeHtml5String wops)+ txt++-- | Like 'orgModeToHTMLWithOpts' but allows returning any JSON compatible object+orgModeToHTMLWithOpts'+ :: (FromJSON a)+ => ReaderOptions -- ^ Pandoc reader options to specify extensions or other functionality+ -> WriterOptions -- ^ Pandoc writer options to modify output+ -> T.Text -- ^ Text for conversion+ -> Action a+orgModeToHTMLWithOpts' rops wops txt =+ orgModeToHTMLWithOpts rops wops txt >>= convert -- | Given a reader from 'Text.Pandoc.Readers' this creates a loader which -- given the source document will read its metadata into a 'Value'