Fp-ts: Idea: documentation website

Created on 6 Feb 2018  路  6Comments  路  Source: gcanti/fp-ts

There is https://github.com/gcanti/fp-ts/tree/master/docs/api/md, but it would be nice to have this as a website

Example: https://funfix.org/api/core/classes/try.html

accepting PRs docs suggestion

All 6 comments

Maybe we can generate the markdown files from source-code types and above-function documentation parsed with support for e.g. markdown.

@gcanti Could you scope out what an ideal solution for you would look like and what level of help you're willing to accept toward that end?

@jasonkuhrt the md files are generated from the source (command npm run docs)

Then we can add a layer on top like Gitbook. I don't think a whole bespoke website is _necessary_.

try this repo?
generate html from md source.

after we fill up the docs we can take the md files and feed it to a static site generator like hakyll

@gcanti worked on generating better API documentation recently (https://github.com/gcanti/docs-ts), which inspired me to start writing docs: https://github.com/gcanti/fp-ts/pull/779

There's still a lot of work ahead, but I'm closing this issue now because we're getting there, slowly but surely 馃槃

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Crashthatch picture Crashthatch  路  4Comments

bobaaaaa picture bobaaaaa  路  4Comments

mattgrande picture mattgrande  路  3Comments

vicrac picture vicrac  路  4Comments

steida picture steida  路  4Comments