{"id":22283675,"url":"https://github.com/fennifith/mdjavadoc","last_synced_at":"2025-06-16T05:05:36.923Z","repository":{"id":57293596,"uuid":"151181722","full_name":"fennifith/mdjavadoc","owner":"fennifith","description":"A script that generates markdown javadocs for use in Jekyll and GitHub Pages.","archived":false,"fork":false,"pushed_at":"2020-04-22T19:09:37.000Z","size":79,"stargazers_count":18,"open_issues_count":6,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-11T21:56:08.126Z","etag":null,"topics":["cli","documentation","javadoc","markdown","nodejs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/mdjavadoc","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fennifith.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-02T00:55:49.000Z","updated_at":"2024-04-18T09:38:55.000Z","dependencies_parsed_at":"2022-09-01T06:40:16.522Z","dependency_job_id":null,"html_url":"https://github.com/fennifith/mdjavadoc","commit_stats":null,"previous_names":["theandroidmaster/mdjavadoc"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fennifith%2Fmdjavadoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fennifith%2Fmdjavadoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fennifith%2Fmdjavadoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fennifith%2Fmdjavadoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fennifith","download_url":"https://codeload.github.com/fennifith/mdjavadoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227960205,"owners_count":17847755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","documentation","javadoc","markdown","nodejs"],"created_at":"2024-12-03T16:41:36.392Z","updated_at":"2024-12-03T16:41:37.174Z","avatar_url":"https://github.com/fennifith.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Markdown Javadoc is a script that generates markdown javadocs primarily for use in Jekyll and GitHub Pages. It consists of two modules, an [API](./api/README.md) and [CLI](./cli/README.md). If you simply want to generate a set of javadocs in markdown without any scripting, the CLI provides a simple interface with a decent amount of options. If you have a more complex use case, however, it might be more beneficial to look into the API first.\n\n## Installation\n\nThese are generic installation instructions that are fairly similar for both the API and CLI. \n\n### NPM\n\n```shell\nnpm install -g mdjavadoc\n```\n\n### From Source\n\n```shell\ngit clone https://github.com/TheAndroidMaster/mdjavadoc\ncd mdjavadoc/cli\nnpm install\nsudo npm link\n```\n\nFor specific usage instructions, see the README for the [API](./api/README.md) or [CLI](./cli/README.md) components.\n\n## Functionality\n\nThe program works by searching a set of files for [javadoc comments](https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html), parsing them into a data structure containing the description, tags, and metadata, and then outputting that data into a set of markdown files. For example, a file containing a javadoc comment like the one below would yield the following structure and output...\n\n##### Javadoc\n\n```java\n/**\n * This is a method which does a thing with something and stuff.\n * \n * @param something\t\tThis is something.\n * @param stuff\t\t\tThis is a bunch of stuff.\n * @return\t\t\tA thing.\n */\npublic static Object doTheThing(int something, String[] stuff) {\n\treturn null;\n}\n```\n\n##### Data\n\n```javascript\n[\n  {\n    name: \"doTheThing\",\n    description: \"This is a method which does a thing with something and stuff.\",\n    type: [\"public\", \"static\", \"void\"],\n    source: \"/package/structure/ClassName.java#L2\",\n    param: [\n      {\n        content: \"@param something\\tThis is something.\",\n        template: [\"Parameter Name\", \"Description\"],\n        values: [\"something\", \"This is something.\"]\n      },\n      {\n        content: \"@param stuff\\t\\tThis is a bunch of stuff.\",\n        template: [\"Parameter Name\", \"Description\"],\n        values: [\"stuff\", \"This is a bunch of stuff.\"]\n      }\n    ],\n    return: [\n      {\n        content: \"@return\\t\\tA thing.\",\n        template: [\"Returned Value\"],\n        values: [\"A thing.\"]\n      }\n    ]\n  }\n]\n```\n\n##### Markdown\n\n```md\n## [doTheThing](../blob/master/package/structure/ClassName.java#L2)\n\n**Type:** `public` `static` `void`\n\nThis is a method which does a thing with something and stuff.\n\n|Parameter Name|Description|\n|-----|-----|\n|something|This is something.|\n|stuff|This is a bunch of stuff.|\n\n**Returned Value:** A thing.\n```\n\n## Contributing\n\nContributions are accepted. See this project's [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for instructions on how to contribute to this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffennifith%2Fmdjavadoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffennifith%2Fmdjavadoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffennifith%2Fmdjavadoc/lists"}