hidocs

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)

<iframe src="https://codesandbox.io/embed/suspicious-sanne-ppii5i?autoresize=1&fontsize=14&hidenavigation=1&theme=dark" style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;" title="test-hidocs-lib" allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking" sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts" ></iframe>

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 [e-mail]: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