@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
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.