lodash/fp
doc generatorThis project aims to generate proper docs for Lodash
's functional programming flavor, aka lodash/fp
.
The end goal would be generate a doc similar to the official documentation. The result can be found HERE.
Lodash FP aims to combine the great functionality given by the library and the ideas of functional programming. Only, this behavior is [documented](FP Guide) in a manner unbefitting of what users are used to with the official documentation.
...values
have that argument now in an arrayLodash's sources are generated using docdown
. What it does is read the source files, extract the JSDoc comments, then generate a Markdown file. By overriding Docdown's behavior, we can change the documentation too, in the methods' signature and example:
...values
arguments into an array argumentconsole.log()
that aim to demonstrate a value was mutated (only in example)npm i
npm run doc:fp
// now open doc/fp.md!