{"id":14263162,"url":"https://github.com/hunghg255/convert-markdown-to-html","last_synced_at":"2026-03-07T20:04:44.719Z","repository":{"id":221109149,"uuid":"753428688","full_name":"hunghg255/convert-markdown-to-html","owner":"hunghg255","description":"Convert Markdown to HTML","archived":false,"fork":false,"pushed_at":"2024-09-16T04:05:00.000Z","size":1079,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-22T06:24:23.938Z","etag":null,"topics":["convert-markdown-to-html","documentation","html","katex","markdown","markdown-it","mermaid","twoslash"],"latest_commit_sha":null,"homepage":"https://hunghg255.github.io/convert-markdown-to-html/","language":"HTML","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/hunghg255.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,"zenodo":null}},"created_at":"2024-02-06T05:12:34.000Z","updated_at":"2024-10-07T02:24:02.000Z","dependencies_parsed_at":"2024-02-09T16:31:29.292Z","dependency_job_id":"00df2279-a3b7-4b30-b47c-7f2b4da2dbf8","html_url":"https://github.com/hunghg255/convert-markdown-to-html","commit_stats":null,"previous_names":["hunghg255/convert-markdown-to-html"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/hunghg255/convert-markdown-to-html","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Fconvert-markdown-to-html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Fconvert-markdown-to-html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Fconvert-markdown-to-html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Fconvert-markdown-to-html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hunghg255","download_url":"https://codeload.github.com/hunghg255/convert-markdown-to-html/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Fconvert-markdown-to-html/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30229590,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T19:01:10.287Z","status":"ssl_error","status_checked_at":"2026-03-07T18:59:58.103Z","response_time":53,"last_error":"SSL_read: 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":["convert-markdown-to-html","documentation","html","katex","markdown","markdown-it","mermaid","twoslash"],"created_at":"2024-08-22T13:02:48.388Z","updated_at":"2026-03-07T20:04:44.703Z","avatar_url":"https://github.com/hunghg255.png","language":"HTML","funding_links":["https://www.buymeacoffee.com/hunghg255"],"categories":["markdown"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href=\"https://www.npmjs.com/package/convert-markdown-to-html\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n\u003cimg src=\"https://api.iconify.design/teenyicons:markdown-outline.svg?color=%2300bfff\" alt=\"logo\" width='100'/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  A script converts markdown to html\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/convert-markdown-to-html\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badge.fury.io/js/csvs-parsers.svg\" alt=\"NPM Version\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/convert-markdown-to-html\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/csvs-parsers.svg?logo=npm\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://bundlephobia.com/result?p=convert-markdown-to-html\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://img.shields.io/bundlephobia/minzip/convert-markdown-to-html\" alt=\"Minizip\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hunghg255/convert-markdown-to-html/graphs/contributors\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://img.shields.io/badge/all_contributors-1-orange.svg\" alt=\"Contributors\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hunghg255/convert-markdown-to-html/blob/main/LICENSE\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badgen.net/github/license/hunghg255/convert-markdown-to-html\" alt=\"License\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- Support Syntax Highlighting\n- Support Github Alert\n- Support Emoji\n- Support Table of Contents\n- Support Mermaid\n- Support Katex\n- Support Twoslash\n\n## Demo\n\n[Demo](https://hunghg255.github.io/convert-markdown-to-html)\n\n## API\n\n```md\n--i: input file\n--o: output file\n--t: title\n--g: github link\n```\n\n## CLI\n\n- Option 1\n\n```bash\nnpx convert-markdown-to-html@latest --i README.md --o docs/index.html --t \"Convert Markdown to HTML\" --g \"https://github.com/hunghg255/convert-markdown-to-html\"\n```\n\n- Option 2\n\n```bash\nnpm i convert-markdown-to-html@latest --save-dev\n```\n\n- Config (file package.json)\n\n```json\n{\n  ...\n  \"scripts\": {\n    ...\n    \"gen-docs\": \"convert-markdown-to-html --i README.md --o docs/index.html --t \\\"Convert Markdown to HTML\\\" --g \\\"https://github.com/hunghg255/convert-markdown-to-html\\\"\"\n  },\n  ...\n}\n```\n\n## Install\n\n- Create a file `mdocs.config.ts` in the root of the project\n\n```ts\nimport { defineConfig } from 'convert-markdown-to-html';\n\nexport default defineConfig({\n  input: 'index.md',\n  output: 'index.html',\n  isTwoSlash: true,\n\n  title: 'My Docs',\n  description: 'My awesome documentation',\n\n  logo: '',\n\n  socialLinks: [\n    {\n      icon: 'twitter',\n      url: 'https://github.com',\n    },\n    {\n      icon: 'github',\n      url: 'https://github.com',\n    },\n  ],\n  footer: {\n    message: 'Released under the MIT License',\n    copyright: 'Copyright © 2023-present Hunghg255',\n  },\n\n  head: [\n    [\n      'link',\n      { rel: 'icon', type: 'image/png', href: 'https://hung.thedev.id/images/patak-banner.jpg' },\n    ],\n    ['meta', { property: 'og:type', content: 'website' }],\n    ['meta', { property: 'og:title', content: ogTitle }],\n    ['meta', { property: 'og:image', content: ogImage }],\n    ['meta', { property: 'og:url', content: ogUrl }],\n    ['meta', { property: 'og:description', content: ogDescription }],\n    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],\n    ['meta', { name: 'twitter:site', content: '@hunghg255' }],\n    ['meta', { name: 'theme-color', content: '#7eaf90' }],\n  ],\n});\n```\n\n- Config (file package.json)\n\n```json\n{\n  ...\n  \"scripts\": {\n    ...\n    \"gen-docs\": \"convert-markdown-to-html\"\n  },\n  ...\n}\n```\n\n## Function\n\n```ts\nimport { markdownToDocs } from 'convert-markdown-to-html';\n\ndeclare const markdownToDocs: (\n  isTwoSlash: boolean;\n  title: string;\n  description?: string;\n  logo?: string;\n  socialLinks?: {\n      icon?: 'twitter' | 'github';\n      url?: string;\n  }[];\n  footer?: {\n      message?: string;\n      copyright?: string;\n  };\n  head?: Array\u003c[string, Record\u003cstring, string\u003e]\u003e;\n) =\u003e Promise\u003cstring\u003e;\n\nconst markdownContent = `# Hello World`;\nconst html = markdownToDocs(markdownContent, {\n  isTwoSlash: true,\n\n  title: 'My Docs',\n  description: 'My awesome documentation',\n\n  logo: '',\n\n  socialLinks: [\n    {\n      icon: 'twitter',\n      url: 'https://github.com',\n    },\n    {\n      icon: 'github',\n      url: 'https://github.com',\n    },\n  ],\n  footer: {\n    message: 'Released under the MIT License',\n    copyright: 'Copyright © 2023-present Hunghg255',\n  },\n\n  head: [\n    [\n      'link',\n      { rel: 'icon', type: 'image/png', href: 'https://hung.thedev.id/images/patak-banner.jpg' },\n    ],\n    ['meta', { property: 'og:type', content: 'website' }],\n    ['meta', { property: 'og:title', content: ogTitle }],\n    ['meta', { property: 'og:image', content: ogImage }],\n    ['meta', { property: 'og:url', content: ogUrl }],\n    ['meta', { property: 'og:description', content: ogDescription }],\n    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],\n    ['meta', { name: 'twitter:site', content: '@hunghg255' }],\n    ['meta', { name: 'theme-color', content: '#7eaf90' }],\n  ],\n});\n```\n\n### About\n\n\u003ca href=\"https://www.buymeacoffee.com/hunghg255\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"\u003e\u003c/a\u003e\n\nGia Hung – [hung.hg](https://hung.thedev.id)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunghg255%2Fconvert-markdown-to-html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhunghg255%2Fconvert-markdown-to-html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunghg255%2Fconvert-markdown-to-html/lists"}