Hackage :: [Package]

yesod-raml-docs: A html documentation generator library for RAML.

[ library, mit, web, yesod ] [ Propose Tags ]

A html documentation generator library for RAML.

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0, 0.1.1
Change log ChangeLog.md
Dependencies base (>=4 && <5), bytestring, containers, shakespeare, template-haskell, text, yaml, yesod-markdown, yesod-raml (>=0.2 && <0.3) [details]
License MIT
Author junji.hashimoto
Maintainer junji.hashimoto@gmail.com
Category Web, Yesod
Bug tracker https://github.com/junjihashimoto/yesod-raml/issues
Source repo head: git clone https://github.com/junjihashimoto/yesod-raml.git
Uploaded by junjihashimoto at 2015-11-09T03:41:02Z
Distributions
Downloads 1299 total (10 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2015-11-09 [all 1 reports]

Readme for yesod-raml-docs-0.1.1

[back to package description]

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