{"id":24113692,"url":"https://github.com/arnozhang/markdown-doc-builder","last_synced_at":"2025-09-18T01:32:22.224Z","repository":{"id":143871778,"uuid":"290126546","full_name":"arnozhang/markdown-doc-builder","owner":"arnozhang","description":"Markdown documents builder. Can output .md and .html files","archived":false,"fork":false,"pushed_at":"2020-08-26T08:31:41.000Z","size":20,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-02T13:34:29.796Z","etag":null,"topics":["builder","document","html","markdown"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/arnozhang.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":"2020-08-25T05:55:21.000Z","updated_at":"2023-10-05T22:43:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c907d8f-eab6-466a-941c-aceb5d1f6147","html_url":"https://github.com/arnozhang/markdown-doc-builder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/arnozhang/markdown-doc-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnozhang%2Fmarkdown-doc-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnozhang%2Fmarkdown-doc-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnozhang%2Fmarkdown-doc-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnozhang%2Fmarkdown-doc-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arnozhang","download_url":"https://codeload.github.com/arnozhang/markdown-doc-builder/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arnozhang%2Fmarkdown-doc-builder/sbom","scorecard":{"id":208001,"data":{"date":"2025-08-11","repo":{"name":"github.com/arnozhang/markdown-doc-builder","commit":"f524806efd6db9dc50ec3095a76b429fef241221"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/7 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T00:10:34.425Z","repository_id":143871778,"created_at":"2025-08-17T00:10:34.425Z","updated_at":"2025-08-17T00:10:34.425Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275695805,"owners_count":25511349,"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","status":"online","status_checked_at":"2025-09-17T02:00:09.119Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["builder","document","html","markdown"],"created_at":"2025-01-11T04:24:29.183Z","updated_at":"2025-09-18T01:32:21.965Z","avatar_url":"https://github.com/arnozhang.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-doc-builder\n\nMarkdown documents builder. Can output .md and .html files\n\n## 1. Usage\n\n\u003e npm install --save markdown-doc-builder\n\nUsing [markdown-doc-builder](https://www.npmjs.com/package/markdown-doc-builder) is quite easy:\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\n// output md\nconst markdownContent = markdown\n    .newBuilder()\n    .h1('Hello')\n    .text('world')\n    .toMarkdown();\n\n// output HTML\nconst htmlContent = markdown\n    .newBuilder()\n    .h1('Hello')\n    .text('world')\n    .toHtml(markdown.defaultHtmlStyles());\n```\n\n## 2. API\n\n### 2.1. Headers\n\nUse the h1, h2, h3, h4, h5, h6 or header to generate a markdown header. Calling header with a level above 6 returns a h6 Header.\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nmarkdown\n    .newBuilder()\n    .h1('Usage')\n    .h1('API')\n    .h2('Headers')\n    .h2('Emphasis')\n    .h2('Lists')\n    .h2('Table')\n    .toMarkdown();\n```\n\n### 2.2. Emphasis\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nmarkdown\n    .newBuilder()\n    .bold('This is bold text')\n    .italic('This is italic text')\n    .boldItalic('This is bold-italic text')\n    .strikethrough('This is strikethrough text');\n```\n\n### 2.3. Lists\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nmarkdown\n    .newBuilder()\n    .list([ 'Java', 'JavaScript', 'TypeScript' ]);\n\nmarkdown\n    .newBuilder()\n    .list([\n        'Java', 'JavaScript', 'TypeScript',\n        'Misc',\n        markdown.newListBuilder().append('a', 'b', 'c'),\n    ]);\n```\n\n### 2.4. Table\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nconst table = markdown\n    .newTableBuilder(0, 2)\n    .header([ 'Option', 'Description' ])\n    .appendRow([ 'data', 'path to data files to supply the data that will be passed into templates.' ])\n    .appendRow([ 'engine', 'engine to be used for processing templates. Handlebars is the default.' ])\n    .appendRow([ 'ext', 'extension to be used for dest files.' ]));\n\nmarkdown\n    .newBuilder()\n    .table(table)\n    .toMarkdown();\n```\n\n### 2.5. Link\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nmarkdown\n    .newBuilder()\n    .link('https://github.com/arnozhang/markdown-doc-builder', 'markdown-doc-builder')\n    .toMarkdown();\n```\n\n### 2.5. Image\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nmarkdown\n    .newBuilder()\n    .image('https://octodex.github.com/images/minion.png', 'Minion')\n    .toMarkdown();\n```\n\n### 2.6. Code\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nmarkdown\n    .newBuilder()\n    .compositeNodes(\n        markdown.text('Inline '),\n        markdown.code('code'))\n    .toMarkdown();\n\nmarkdown\n    .newBuilder()\n    .codeBlock(MarkdownCodeType.Json, JSON.stringify({\n        name: 'Arno Zhang',\n        github: 'https://github.com/arnozhang',\n    }, null, 4))\n    .toMarkdown();\n```\n\n## 3. Output HTML\n\n\n```typescript\nimport markdown from 'markdown-doc-builder';\n\n\nconst styles = markdown\n    .defaultStyles()\n    .globalCss(\"body {color: #000; font-size: 15px;}\");\n\nconst htmlContent = markdown\n    .newBuilder()\n    .xxx()\n    .toHtml(styles);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farnozhang%2Fmarkdown-doc-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farnozhang%2Fmarkdown-doc-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farnozhang%2Fmarkdown-doc-builder/lists"}