LiterateMarkdown: Converter to convert from .lhs to .md and vice versa.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

lhsc is a program to convert literate haskell files in the birdtick format to correctly rendered (git flavoured, html containing) markdown files and vice versa.

It strips away the heading tags #, replacing them with the corresponding html tags, converts the `'''haskell [...]'''` to `> [...]` as recognised by the GHC literate prepocessor. `''' [...] '''` will be converted to `< [...]` and will be discarded by ghc but will still be displayed as code when rendered. (In both cases `'''` is actually the three md backticks, but its a pain to write md about md.)

Usage:

`lhsc (toLhs|toMd) file1 [file2] [...]`; The toLhs and toMd commands are not case sensitive. The program will convert each file from the other format to the specified one, creating the files file1.md file2.md ... or file1.lhs file2.lhs ... in the same directory respectively.


[Skip to ReadMe]

Properties

Versions0.1.0.0, 0.1.0.0
Change logCHANGELOG.md
Dependenciesbase (>=4.12.0.0 && <4.13) [details]
LicenseMIT
AuthorFabian Schneider
Maintainerfaebl.taylor@pm.me
CategoryProductivity
Bug trackerhttps://github.com/faeblDevelopment/LiterateMarkdown/issues
Source repositoryhead: git clone https://github.com/faeblDevelopment/LiterateMarkdown.git -b main
Executableslhsc
Uploaded2020-04-13T15:30:03Z by FabianSchneider

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for LiterateMarkdown-0.1.0.0

[back to package description]

lhcs - a prepocessor for literate haskell markdown

A Converter to convert from .lhs to .md and vice versa

lhsc is a program to convert literate haskell files in the birdtick format to correctly rendered (git flavoured, html containing) markdown files and vice versa.

It strips away the heading tags #, replacing them with the corresponding html tags, converts the '''haskell [...]''' to > [...] as recognised by the GHC literate prepocessor. ''' [...] ''' will be converted to < [...] and will be discarded by ghc but will still be displayed as code when rendered. (In both cases ''' is actually the three md backticks, but its a pain to write md about md.)

Usage

lhsc (toLhs|toMd) file1 [file2] [...] The toLhs and toMd commands are not case sensitive. The program will convert each file from the other format to the specified one, creating the files file1.md file2.md ... or file1.lhs file2.lhs ... in the same directory respectively.

To install the executeable on windows, if you can't convince cabal to use --bindir-method=copy you can build the project locally and copy the built executeable to C:/Users/username/AppData/Roaming/cabal/bin and ensure that this directory is in your path.