baldrick-doc-ts

Documentation generator for typescript projects

Generation of documentation for node.js libraries written in Typescript

Highlights:

• Written in Typescript

• It relies on typedoc under the hood.

• It can be run directly using npx.

• It generate the documentation as markdown. This provides a more basic documentation that the default typedoc but does not generate any html or css that would become part of the source code, and may raise some warnings with many linters.

• It is part of the baldrick suite of tools, and is optimized to work alongside these.

Documentation and links

• Code Maintenance
• Code Of Conduct
• Api for baldrick-doc-ts
• Contributing
• Glossary
• Diagram for the code base
• Vocabulary used in the code base
• Architectural Decision Records
• Contributors
• Dependencies
• Usage

Related

• baldrick-zest-engine Run tests declaratively with a few cunning plans

Installation

This package is ESM only.

yarn global add baldrick-doc-ts
baldrick-doc-ts --help

Or alternatively run it:

npx baldrick-doc-ts --help

If you want to tun the latest version from github. Mostly useful for dev:

git clone [e-mail]:flarebyte/baldrick-doc-ts.git
yarn global add `pwd`