{"id":15130923,"url":"https://github.com/chalarangelo/markdown-builder","last_synced_at":"2025-09-28T21:30:30.645Z","repository":{"id":57291206,"uuid":"148766823","full_name":"Chalarangelo/markdown-builder","owner":"Chalarangelo","description":"1kb Markdown builder for Node.js","archived":true,"fork":false,"pushed_at":"2019-11-06T21:34:42.000Z","size":271,"stargazers_count":91,"open_issues_count":2,"forks_count":18,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-01-15T08:56:49.061Z","etag":null,"topics":["builder","library","markdown","node","npm"],"latest_commit_sha":null,"homepage":"","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/Chalarangelo.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-09-14T09:28:20.000Z","updated_at":"2024-11-30T05:46:16.000Z","dependencies_parsed_at":"2022-09-01T15:21:45.274Z","dependency_job_id":null,"html_url":"https://github.com/Chalarangelo/markdown-builder","commit_stats":null,"previous_names":["flxwu/markdown-builder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chalarangelo%2Fmarkdown-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chalarangelo%2Fmarkdown-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chalarangelo%2Fmarkdown-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chalarangelo%2Fmarkdown-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chalarangelo","download_url":"https://codeload.github.com/Chalarangelo/markdown-builder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234563128,"owners_count":18853058,"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":["builder","library","markdown","node","npm"],"created_at":"2024-09-26T03:08:34.594Z","updated_at":"2025-09-28T21:30:30.306Z","avatar_url":"https://github.com/Chalarangelo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown builder for Node \n[![Build Status](https://api.travis-ci.org/30-seconds/markdown-builder.svg?branch=master)](https://travis-ci.org/30-seconds/markdown-builder)\n![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/markdown-builder.svg)\n![npm](https://img.shields.io/npm/v/markdown-builder.svg)\n\n\u003e Official README builder for the 30-seconds projects.\n\n## Usage\n```bash\nnpm install --save markdown-builder\n```\n\nUsing `markdown-builder` is quite easy:\n```js\nconst markdown = require('markdown-builder');\nconst { headers } = markdown;\n\nheaders.hX(3, '3rd Header') // ### 3rd Header\n```\n\n## Example\n**Check out [30-seconds-of-code](https://github.com/Chalarangelo/30-seconds-of-code)'s READMEs, they are automatically generated using `markdown-builder`**\n\n## API\n\n### Headers\nUse the `h1`,`h2`,`h3`,`h4`,`h5`,`h6` or `hX` to generate a markdown header. Calling `hX` with a level above `6` returns a `h6` Header.\n\n```js\nconst markdown = require('markdown-builder')\nconst { headers } = markdown\n\nheaders.h1('1st Header') // # 1st Header\nheaders.h2('2nd Header') // ## 2nd Header\nheaders.h3('3rd Header') // ### 3rd Header\nheaders.hX(5, '5th Header using hX') // ##### 5th Header using hX\n```\n\n### Emphasis\n```js\nconst markdown = require('markdown-builder')\nconst { emphasis } = markdown\n\nemphasis.b('bold text')\nemphasis.i('italic text')\nemphasis.s('strikethrough text')\n```\n\n### Lists\n```js\nconst markdown = require('markdown-builder')\nconst { lists } = markdown\n\nlet a = ['Item 1', 'Item 2']\n// ordered list\nlists.ol(a)\n// 1. Item 1\n// 2. Item 2\nlists.ol(a, (item) =\u003e item.toUpperCase()) // use callbacks to alter each item\n// 1. ITEM 1\n// 2. ITEM 2\n\n// unordered List\nlists.ul(a)\nlists.ul(a, (item) =\u003e item.toUpperCase())\n```\n\n### Miscellaneous\n\n```js\nconst markdown = require('markdown-builder')\nconst { misc } = markdown\n\n// Images\nlet alt = 'image of lights', url = 'https://www.w3schools.com/w3css/img_lights.jpg', title = 'lights'\nmisc.image(alt, url)\nmisc.image(alt, url, title)\n\n// Collapsible summary/details block\nmisc.collapsible('Summary', 'content');\n\n// Github Anchor\nmisc.anchor('A header with /*() special-characters!'); // #a-header-with--special-characters\n\n// Link\nmisc.link('Github', 'https://github.com/flxwu')\n\n// horizontal rule\nmisc.hr()\n\n```\n\n**Collapsible**:\n\n\u003cdetails\u003e\n\t\u003csummary\u003eSummary\u003c/summary\u003e\n\tContent\n\u003c/details\u003e\n\n\n\n#### A header with /*() special-characters!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchalarangelo%2Fmarkdown-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchalarangelo%2Fmarkdown-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchalarangelo%2Fmarkdown-builder/lists"}