{"id":19030830,"url":"https://github.com/hackclub/markdown","last_synced_at":"2025-09-23T21:08:23.342Z","repository":{"id":45967464,"uuid":"238070087","full_name":"hackclub/markdown","owner":"hackclub","description":"Render Markdown to HTML, Hack Club-style","archived":false,"fork":false,"pushed_at":"2023-07-16T03:36:38.000Z","size":1431,"stargazers_count":20,"open_issues_count":3,"forks_count":2,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-02-14T05:10:06.875Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://markdown.hackclub.com/","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/hackclub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-02-03T21:56:16.000Z","updated_at":"2024-07-30T01:57:33.000Z","dependencies_parsed_at":"2024-06-19T20:04:07.452Z","dependency_job_id":"b175a7a1-54d0-4b24-9728-694b4a67d0cd","html_url":"https://github.com/hackclub/markdown","commit_stats":{"total_commits":36,"total_committers":6,"mean_commits":6.0,"dds":0.5,"last_synced_commit":"d3f8142814e2eb918d532df9b80a4415bd303d03"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fmarkdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fmarkdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fmarkdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fmarkdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackclub","download_url":"https://codeload.github.com/hackclub/markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240080526,"owners_count":19744878,"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":[],"created_at":"2024-11-08T21:19:45.987Z","updated_at":"2025-09-23T21:08:18.323Z","avatar_url":"https://github.com/hackclub.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `@hackclub/markdown`\n\nRender Markdown to HTML, Hack Club-style. Used primarily on the [Hack Club Workshops](https://hackclub.com/workshops/) site.\n\n```sh\nyarn add @hackclub/markdown\n# npm i @hackclub/markdown\n```\n\n[**Try the demo**](https://markdown.hackclub.com)\n\n## Usage\n\nThis package does not include any frontend code, such as React or CSS.\n\nThis package is designed for rendering at build or otherwise on a server, not client-side—\nthe bundle size is significant \u0026 it’s not been optimized for performance.\n\nAlways use with `await`.\n\n```js\nimport fs from 'fs'\nimport md from '@hackclub/markdown'\n\nconst getReadme = async () =\u003e (\n  const text = fs.readFileSync('./README.md', 'utf8')\n  return await md(text, '/README.md', '/static')\n)\n```\n\n| Param       | Default        | Description                                                     |\n| ----------- | -------------- | --------------------------------------------------------------- |\n| input       | Req’d!         | String. The Markdown text to transform.                         |\n| filePath    | `'/README.md'` | String. The Markdown’s path (for fixing relative image links).  |\n| imagePrefix | `'/'`          | String. A prefix for the path to relative images.               |\n| removeTitle | `false`        | Bool. Remove starting `h1` (if titles are rendered separately). |\n\nIf you need to parse frontmatter, we recommend using [gray-matter](https://npm.im/gray-matter)\nalongside `@hackclub/markdown`, but it’s not included in this package.\n\n***\n\nPartially based on the [Next.js documentation site](https://github.com/zeit/next-site/pull/473/files#diff-879732a0915babd1688248ad1144c2d4).\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackclub%2Fmarkdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackclub%2Fmarkdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackclub%2Fmarkdown/lists"}