docs-ts
docs-ts copied to clipboard
gcanti
A zero-config documentation tool for my TypeScript projects
I've been trying to see how to update [`fp-ts-rxjs`](https://github.com/gcanti/fp-ts-rxjs) with the latest version of rxjs, however as has been [noted before](https://github.com/gcanti/fp-ts-rxjs/pull/67#issue-1046788966), the docs that are generated afterwards have the type...
I'm working on releasing a few libraries to help expand the fp-ts ecosystem; the first one being (hopefully) a logging library (building on the `logging-ts` foundations). It's similar to the...
Another small one: Should we omit the `.ts` in the generated module names in the sidebar?
**Do you want to request a _feature_ or report a _bug_?** Feature: Forward options to ``ts-morph``. **What is the current behavior?** ``docs-ts`` provides ``{"strict": true}`` as configuration to the ``ts-morph``...
**What is the current behavior?** When modules only have _export from_ statements it results in an empty ToC. Eg. the following `src/http/index.ts` file: ```ts export * from './http' export *...
As discussed in #40, here's a draft that enables previewing the generated docs locally. _**NOTE on formatting in the README.md:**_ Excuse me for the unclean diff, but that's what prettier...
Currently a rule such as `enforceExamples` is enforced against everything indiscriminately. This poses a challenge if I want to enable it in a repo like fp-ts where there's for example...
Currently `docs-ts` [uses prettier to format](https://github.com/gcanti/docs-ts/blob/3a98908f6fd9aa2d47fe23df57bf9422b7f346d1/src/Markdown.ts#L568) markdown before writing out the docs. The used options are: ```ts const prettierOptions: prettier.Options = { parser: 'markdown', semi: false, singleQuote: true, printWidth: 120...
Currently, we only mention in the README: "...the generated output of docs-ts can be used as a publishing source for your repository's documentation on GitHub". ## Workable Recipe Maybe it...