The yesod-raml-docs package

[Tags:library, mit]

A html documentation generator library for RAML.


[Skip to Readme]

Properties

Versions 0.1.0, 0.1.1
Change log ChangeLog.md
Dependencies base (==4.*), bytestring, containers, shakespeare, template-haskell, text, yaml, yesod-markdown, yesod-raml (==0.2.*) [details]
License MIT
Author junji.hashimoto
Maintainer junji.hashimoto@gmail.com
Category Web, Yesod
Bug tracker https://github.com/junjihashimoto/yesod-raml/issues
Source repository head: git clone https://github.com/junjihashimoto/yesod-raml.git
Uploaded Mon Nov 9 03:41:02 UTC 2015 by junjihashimoto
Distributions NixOS:0.1.1
Downloads 128 total (8 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2015-11-09 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for yesod-raml-docs

Readme for yesod-raml-docs-0.1.1

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")