{"id":21351880,"url":"https://github.com/hygull/node-markdown","last_synced_at":"2026-04-17T00:02:25.538Z","repository":{"id":80468696,"uuid":"160852962","full_name":"hygull/node-markdown","owner":"hygull","description":"An npm package which allows to generate a markdown file using a pure object oriented oriented approach which can be used to create documentation (README.md) for projects.","archived":false,"fork":false,"pushed_at":"2018-12-20T17:01:35.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T04:41:30.409Z","etag":null,"topics":["documentation","documentation-generator","file-creation","html5","markdown","node-module"],"latest_commit_sha":null,"homepage":"https://hygull.github.io/node-markdown/","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/hygull.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-07T17:06:27.000Z","updated_at":"2018-12-20T17:01:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"192372a6-d725-4174-aedc-ebecf183d819","html_url":"https://github.com/hygull/node-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hygull/node-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hygull%2Fnode-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hygull%2Fnode-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hygull%2Fnode-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hygull%2Fnode-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hygull","download_url":"https://codeload.github.com/hygull/node-markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hygull%2Fnode-markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31909235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"ssl_error","status_checked_at":"2026-04-16T18:21:47.142Z","response_time":69,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","documentation-generator","file-creation","html5","markdown","node-module"],"created_at":"2024-11-22T03:11:41.595Z","updated_at":"2026-04-17T00:02:25.447Z","avatar_url":"https://github.com/hygull.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 id=\"readme\"\u003enode-markdown\u003c/h1\u003e\n\nAn npm package which allows to generate a markdown file using a pure object oriented oriented approach which can be used to create documentation (README.md) for projects.\n\n\u003e You can also visit [https://hygull.github.io/node-markdown/](https://hygull.github.io/node-markdown/) and read the beautiful documentation.\n\n\u003ch2 id=\"installation\"\u003eInstallation\u003c/h2\u003e\n\n| Type | Command |\n| --- | --- |\n| Locally | `npm install  node-markdown` |\n| Globally | `npm install  node-markdown  -g` |\n\n\u003ch2 id=\"why-markdown\"\u003eWhat is markdown and who developed it?\u003c/h2\u003e\n\n+ Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.\n\n+ **Developed by** \u0026raquo; **John Gruber** (in collaboration with **Aaron Swartz** on the syntax)\n\n\n\u003ch2 id='examples'\u003eExamples\u003c/h2\u003e\n\n* \u003ca href=\"#link-to-visit\"\u003eGet/set visit links\u003c/a\u003e\n\n* \u003ca href=\"#link-to-display-image\"\u003eGet/set markdown code to display image\u003c/a\u003e\n\n\u003e Please look into the below well commented examples to have a quick taste. \n\n\u003ch3 id=\"link-to-visit\"\u003eGet/set visit links\u003c/h3\u003e\n\n```javascript\nconst {Markdown} = require(\"node-markdown\");\nconst md = new Markdown();\n\n/* Get anchor link (to visit)\n   ==========================\n   \n   [Visit w3schools](https://www.w3schools.com)\n*/\nconsole.log(md.getTextLink(\"Visit w3schools\", \"https://www.w3schools.com\"));\n\n/* Set anchor link (to visit)\n   ==========================\n\n\t{\n\t    \"elements\": [\n\t        \"[Visit w3schools](https://www.w3schools.com)\"\n\t    ]\n\t}\n*/\nmd.setTextLink('Visit w3schools', 'https://www.w3schools.com');\nconsole.log(JSON.stringify(md.markdown, null, 4));\n\n```\n\n\u003ch3 id=\"link-to-display-image\"\u003eGet/set markdown code to display image\u003c/h3\u003e\n\n```javascript\nconst {Markdown} = require(\"node-markdown\");\nconst md = new Markdown();\n\n\n/* Get image link (to display)\n   ===========================\n\n   ![Graph icon]{https://image.flaticon.com/icons/svg/123/123407.svg}\n*/\nconsole.log(md.getImageLink(\"Graph icon\", \"https://image.flaticon.com/icons/svg/123/123407.svg\"));\n\n/* Set image link (to display)\n   ===========================\n\n\t{\n\t    \"elements\": [\n\t        \"![Graph icon]{https://image.flaticon.com/icons/svg/123/123407.svg}\"\n\t    ]\n\t}\n*/\nmd.setImageLink('Graph icon', 'https://image.flaticon.com/icons/svg/123/123407.svg');\nconsole.log(JSON.stringify(md.markdown, null, 4));\n\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhygull%2Fnode-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhygull%2Fnode-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhygull%2Fnode-markdown/lists"}