Hi Docs

Sample project with tsup and tsc, generates the documentation TSDOC standard and typedoc tool

See the Doc online

🏄🏻‍♀️ https://hidocs.netlify.app/

Code

[codesandbox.io)(https://codesandbox.io/embed/suspicious-sanne-ppii5i?autoresize=1&fontsize=14&hidenavigation=1&theme=dark)

Markdown

Web Page

Install

npm i hidocs

Usage

import {sayGoodbye, sayHello} from 'hidocs'l

console.log(sayHello("Thiago");

console.log(sayGoodbye({ name: "John", age: 30 }));

Run Example

git clone [email protected]:tgmarinho/poc-ts-doc.git
cd poc-ts-doc/example
npm i

You can code example/src/index.ts file.

Refs

• https://tsdoc.org/
• https://tsdoc.org/play#
• https://typedoc.org/
• https://typedoc.org/example/
• eslint-plugin-tsdoc

Blog Posts about

• documenting your typescript projects
• generating documentation for typescript-projects
• how to write ts interfaces in jsdoc

Author

🧢 Thiago Marinho