tintin: A softer alternative to Haddock

[ apache, documentation, library, program ] [ Propose Tags ]

Please see the website https://theam.github.io/tintin

[Skip to Readme]
Versions [faq] 1.0.3, 1.0.4, 1.2.4, 1.2.5, 1.3.5, 1.4.5, 1.4.6, 1.5.0, 1.7.0, 1.7.1, 1.8.0, 1.9.0, 1.9.1, 1.9.2, 1.9.4, 1.9.5, 1.10.0, 1.10.1
Change log ChangeLog.md
Dependencies base (>=4.7 && <5), clay, containers, data-has, directory, frontmatter, inflections, inliterate, lucid, optparse-generic, process, require, temporary, text, tintin, universum, yaml [details]
License Apache-2.0
Copyright 2020 Theam
Author The Agile Monkeys
Maintainer hackers@theam.io
Category Documentation
Home page https://github.com/theam/tintin#readme
Bug tracker https://github.com/theam/tintin/issues
Source repo head: git clone https://github.com/theam/tintin
Uploaded by NickSeagull at 2020-01-23T13:44:15Z
Distributions NixOS:1.10.1, Stackage:1.10.0
Executables tintin
Downloads 6624 total (8 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-01-23 [all 1 reports]


[Index] [Quick Jump]


Maintainer's Corner

For package maintainers and hackage trustees

Readme for tintin-1.10.1

[back to package description]


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

Proceed to site to learn how to use Tintin.


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| A softer alternative to Haddock | |backprop| Heterogeneous automatic differentiation | |hedn| EDN parsing and encoding |


tintin - Copyright © 2018 Theam