@eeue56/geiriadur
Advanced tools
An Elm-style documentation generator for TypeScript. It uses a markdown file to document exposed types and functions, along with their type signature and any jsdoc they may have. There is also a link to the source included.
Part of the Hiraeth collection.
export function program<Model, Msg>(program: Program<Model, Msg>) {}
will generate this
npm install --save @eeue56/geiriadur
npx @eeue56/geiriadur
will find docs within the current tsconfig.json and generate them in a docs folder. Check out an example here
Geiriadur means dictionary. An English speaker may pronounce it as "gay-rh-ya-dirh".
FAQs
An Elm-like documentation generator for TypeScript
The npm package @eeue56/geiriadur receives a total of 0 weekly downloads. As such, @eeue56/geiriadur popularity was classified as not popular.
We found that @eeue56/geiriadur 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.
Security News
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
Research
Security News
Socket researchers uncovered a backdoored typosquat of BoltDB in the Go ecosystem, exploiting Go Module Proxy caching to persist undetected for years.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.