Copyright	(c) Colin Woodbury 2020 - 2021
License	BSD3
Maintainer	Colin Woodbury <colin@fosskers.ca>
Safe Haskell	None
Language	Haskell2010

Data.Org.Lucid

Contents

HTML Conversion
Styling

Description

This library converts OrgFile values into Html structures from the Lucid library. This allows one to generate valid, standalone HTML pages from an Org file, but also to inject that HTML into a preexisting Lucid Html structure, such as a certain section of a web page.

Synopsis

html :: OrgStyle -> OrgFile -> Html ()
body :: OrgStyle -> OrgFile -> Html ()
toc :: OrgStyle -> OrgFile -> Html ()
data OrgStyle = OrgStyle {
- includeTitle :: Bool
- tableOfContents :: TOC
- bootstrap :: Bool
- bulma :: Bool
- highlighting :: Highlighting
- sectionStyling :: SectionStyling
- separator :: Maybe Char
}
defaultStyle :: OrgStyle
newtype TOC = TOC {
- tocDepth :: Word
}
type Highlighting = Maybe Language -> Text -> Html ()
type SectionStyling = Int -> Html () -> Html () -> Html ()
codeHTML :: Highlighting

HTML Conversion

Consider defaultStyle as the style to pass to these functions.

html :: OrgStyle -> OrgFile -> Html () Source #

Convert a parsed OrgFile into a full HTML document readable in a browser.

body :: OrgStyle -> OrgFile -> Html () Source #

Convert a parsed OrgFile into the body of an HTML document, so that it could be injected into other Lucid Html structures.

Does not wrap contents in a <body> tag.

toc :: OrgStyle -> OrgFile -> Html () Source #

Generate a Table of Contents that matches some Html produced by html or body.

Styling

data OrgStyle Source #

Rendering options.

Constructors

OrgStyle

Fields

includeTitle :: Bool
Whether to include the #+TITLE: ... value as an h1 tag at the top of the document.
tableOfContents :: TOC
Settings for the generated Table of Contents. The displayed depth is configurable.
bootstrap :: Bool
Whether to add Twitter Bootstrap classes to certain elements.
bulma :: Bool
Whether to add Bulma classes to certain elements.
highlighting :: Highlighting
A function to give <code> blocks syntax highlighting.
sectionStyling :: SectionStyling
separator :: Maybe Char
Char to insert between elements during rendering, for example having a space between words. Asian languages, for instance, might want this to be Nothing.

defaultStyle :: OrgStyle Source #

Include the title and 3-level TOC named Table of Contents, don't include Twitter Bootstrap classes, use no custom syntax highlighting, separate words with a whitespace character, and don't insert an <hr> between major sections. This mirrors the behaviour of Emacs' native HTML export functionality.

newtype TOC Source #

Options for rendering a Table of Contents in the document.

Constructors

TOC
Fields tocDepth :: Word The number of levels to give the TOC.

type Highlighting = Maybe Language -> Text -> Html () Source #

A function to give <code> blocks syntax highlighting.

type SectionStyling = Int -> Html () -> Html () -> Html () Source #

A post-processing function to apply to a Section to give it extra formatting. The Int is the header depth.

codeHTML :: Highlighting Source #

Mimicks the functionality of Emacs' native HTML export.