homepage: https://github.com/theam/tintin#readme
changelog-type: markdown
hash: b9dc49740b07208f1bcd0aa114d51f7f6039a02757d2949c5b2d60c3632119be
test-bench-deps:
  base: ! '>=4.7 && <5'
  tintin: -any
maintainer: hackers@theam.io
synopsis: A softer alternative to Haddock
changelog: ! '# Changelog for tintin


  ## Unreleased changes

'
basic-deps:
  data-has: -any
  lucid: -any
  clay: -any
  optparse-generic: -any
  frontmatter: -any
  base: ! '>=4.7 && <5'
  text: -any
  universum: -any
  process: -any
  tintin: -any
  temporary: -any
  yaml: -any
  inliterate: -any
  directory: -any
all-versions:
- '1.0.3'
author: The Agile Monkeys
latest: '1.0.3'
description-type: markdown
description: ! '# Tintin


  Tintin allows you to create fancy **plug ''n'' play** documentation sites for your
  Haskell project very easily.


  [Proceed to site](https://theam.github.io/tintin) to learn how to use Tintin.


  # FAQ


  ## Why not just use Haddock?


  Haddock provides a great interface for writing API documentation, which is a kind
  of *hard documentation*.

  Newcomers from other languages are used to have a website per library, but sometimes
  this gets uncomfortable,

  as maintaining a documentation website is more work for the author.


  Tintin helps with this problem, as you get styling and organization for free. You
  just have to write your

  documentation using Markdown.


  The website generation is focused towards guides and tutorials, helping your users
  understand how to use your

  package easily.


  ## Why not using ReadTheDocs or GitBook?


  ReadTheDocs and GitBook are well established solutions for documentation, but they
  don''t provide automatic

  compilation and evaluation of Haskell code. This is error prone and can lead to
  confuse your users.


  Tintin is tightly integrated with Haskell and its tools, helping you to document
  your library in a very easy

  way.


  # Projects using Tintin


  Please submit a PR if you are using Tintin!


  |λ|λ|

  |-|-|

  |[Tintin](https://theam.github.io/tintin)| A softer alternative to Haddock |


  # Copyright


  tintin - Copyright © 2018 [Theam](http://theam.io)


'
license-name: Apache-2.0

Update from Hackage at 2018-05-22T09:58:14Z
Update from Hackage at 2018-05-22T09:58:14Z
