Go to file
Ivan Lazar Miljenovic 4f8df0ebe2 Make sure code blocks are indented in markdown documentation
This relies on the behaviour of pandoc, and as such may not apply to
other Markdown renderers.

Before this change, you would have something like:

> - Example: `application/json`
>
> ```javascript
> "HELLO, HASKELLER"
> ```

When converting this to HTML, PDF, etc. the code block is _not_
contained within the bullet point.

With this change, the generated markdown looks like:

> - Example: `application/json`
>
>     ```javascript
> "HELLO, HASKELLER"
>     ```

With pandoc at least, this effectively indents the entire code block
to be under the bullet point, which is the intended effect.

Note that the code itself is _not_ indented (which might break other
Markdown renderers) as to do so would require splitting on newlines,
which may have unintended consequences when dealing with generated
values (may contain `\r\n`, etc.).
2017-10-05 16:29:43 +11:00
doc Update docs related to hoistServer 2017-10-01 20:24:22 +03:00
scripts switch ci to stack and add ci cron job to test hackage breakage 2016-08-17 14:12:12 +02:00
servant Update docs related to hoistServer 2017-10-01 20:24:22 +03:00
servant-client Fix issue #821 2017-09-28 19:15:53 -04:00
servant-client-core Use own throw/catch 2017-09-15 14:57:03 -04:00
servant-docs Make sure code blocks are indented in markdown documentation 2017-10-05 16:29:43 +11:00
servant-foreign Merge pull request #767 from fierce-katie/docs-combinators 2017-08-16 15:31:12 +03:00
servant-server Update docs related to hoistServer 2017-10-01 20:24:22 +03:00
.gitignore Add hoistServer to HasServer 2017-09-14 12:04:34 +03:00
.stylish-haskell.yaml Contributing 2015-08-17 23:50:42 +02:00
.travis.yml Ignore -Wno-missing-home-modules in travis 2017-09-14 14:37:07 +03:00
cabal.project Update docs related to hoistServer 2017-10-01 20:24:22 +03:00
CONTRIBUTING.md Mention servant-contrib repository 2017-01-20 20:20:10 +02:00
HLint.hs Contributing 2015-08-17 23:50:42 +02:00
README.md Bump servant-docs version to 0.11 2017-07-24 10:54:11 +03:00
servant.png Update READMEs 2015-04-20 15:48:37 +02:00
sources.txt Move servant-js to own repo 2016-10-08 15:08:07 +01:00
stack-ghc-7.8.4.yaml Fix 7.8.4 IsList Sequence issue 2017-09-14 11:23:42 -04:00
stack-ghc-7.10.3.yaml More reorganization 2017-09-14 09:54:13 -04:00
stack-ghc-8.2.1.yaml Review fixes 2017-09-14 13:21:53 -04:00
stack.yaml More reorganization 2017-09-14 09:54:13 -04:00

servant - A Type-Level Web DSL

servant

Getting Started

We have a tutorial that introduces the core features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.

The central documentation can be found here. Other blog posts, videos and slides can be found on the website.

If you need help, drop by the IRC channel (#servant on freenode) or mailing list.

Version history

This table lists the versions of some servant- libraries at the point of release of servant package.

0.10 0.11
servant 0.10 0.11
servant-blaze 0.7.1 ?
servant-cassava 0.7 ?
servant-client 0.10 0.11
servant-docs 0.10 0.11
servant-foreign 0.10 0.10.0.1
servant-js 0.9.1 ?
servant-lucid 0.7.1 ?
servant-mock 0.8.1.1 ?
servant-server 0.10 0.11
servant-swagger 1.1.2.1 ?

Contributing

See CONTRIBUTING.md