Given a TS file, generate markdown documentation for all it's exports.
pnpm i ts-to-md
See API.md for an example output.
ts-to-md -i src/index.ts -o docs/index.md
See ts-to-md --help for more a list of options.
import { generate } from 'ts-to-md';
const markdown = generate({ inputFile: './index.ts' });
pnpm i
All testing is done via simple E2E tests. To run them, run:
pnpm test
To create a test case, create two files:
{test-name}.input.ts - This is the input file being checked{test-name}.output.md - This defines the expected outputFAQs
Generate markdown docs from a typescript file
The npm package ts-to-md receives a total of 0 weekly downloads. As such, ts-to-md popularity was classified as not popular.
We found that ts-to-md demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket researchers uncover how threat actors weaponize Discord across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Socket now integrates with Bun 1.3’s Security Scanner API to block risky packages at install time and enforce your organization’s policies in local dev and CI.
Research
The Socket Threat Research Team is tracking weekly intrusions into the npm registry that follow a repeatable adversarial playbook used by North Korean state-sponsored actors.