@hackage yesod-raml-docs0.1.0

A html documentation generator library for RAML.

Categories
- Web Development
License
MIT
Maintainer
junji.hashimoto@gmail.com
Links
Versions
- 0.1.1 Mon, 9 Nov 2015
- 0.1.0 Fri, 6 Nov 2015

Installation
In your cabal file:
Dependencies (9)
- base >=4 && <5
- bytestring
- containers
- template-haskell
- text
- shakespeare
Dependents (1)
@hackage/yesod-raml-bin

Yesod-Raml-Docs:

Yesod-Raml-Docs makes a html-document from RAML File.

The template of html document uses Hamlet(Shakespeare).

Though the template is Hamlet, original template is numjucks of raml2html. To convert numjucks to Hamlet, I used html2hamlet.

Usage

parseRamlDocsFile makes Html data type from RAML file. Example is below.

getHelpR ::  Handler Html
getHelpR = return  $(parseRamlDocsFile "config/routes.raml")