Latest
{ "additionalInfo": { "title": "Markdeno", "content": "[](https://github.com/ThatGhostYT/markdeno/actions/workflows/ci.yml)\n\nMarkDeno is a library that turns your code into markdown documentation.\n\n> **MarkDeno is a work in progress, so be patient as new tags and kinds are added.**\n\n```ts\nimport * as MarkDeno from \"https://deno.land/x/markdeno/mod.ts\";\n\nMarkDeno.writeMarkdown(\"input.ts\",\"output.md\");\n```\n\n## Supported JSDoc Tags (more coming soon)\n\n> **1.** `param`\n> **2.** `example`\n> **3.** `returns`\n\n## Supported Kinds (more coming soon)\n\n> **1.** `function`\n> **2.** `interface`\n> **3.** `variable`\n> **4.** `import`\n\n## Utilizing the CLI\n\nFirst, run the following command in your terminal.\n\n```sh\ndeno install --allow-run --allow-write --allow-read -n markdeno -rf https://deno.land/x/markdeno/cli.ts\n```\n\nNow, run `markdeno -h` for a help menu on the cli.\n\n## Installing a previous version\n\nYou can either do it with the markdeno cli or with deno install\n\nDeno install:\n\n```sh\ndeno install --allow-run --allow-write --allow-read -n markdeno -rf https://deno.land/x/markdeno@v{VERSION}/cli.ts\n```\n\n> **Note:** Older versions of markdeno do **not** have a cli.ts file. The oldest version with a cli is [0.2.0](https://deno.land/x/markdeno@v0.2.0).\n\nReinstalling with markdeno cli:\n\n```sh\nmarkdeno reinstall -r {VERSION}\n```\n\n> **Note:** Version 0.2.0 reinstall command is a little different as the flag name is `-v` and not `-r`.\n\n## Important Links\n\n> **1.** [Deno doc type definitions](https://deno.land/x/deno_doc@0.51.0/lib/types.d.ts)\n> **2.** [Deno doc command overview](https://deno.land/manual/tools/documentation_generator)" }}