{"id":28327236,"url":"https://github.com/karlisup/chewingum","last_synced_at":"2025-09-01T08:50:34.621Z","repository":{"id":57197848,"uuid":"79725237","full_name":"karlisup/chewingum","owner":"karlisup","description":"A simple, flexible Documentation generator for Pattern Library.","archived":false,"fork":false,"pushed_at":"2018-09-24T21:15:56.000Z","size":426,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-09T03:11:14.693Z","etag":null,"topics":["component-library","css","documentation-generator","pattern-library"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/karlisup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-22T15:17:02.000Z","updated_at":"2018-02-05T09:29:25.000Z","dependencies_parsed_at":"2022-09-16T13:12:12.855Z","dependency_job_id":null,"html_url":"https://github.com/karlisup/chewingum","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/karlisup/chewingum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlisup%2Fchewingum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlisup%2Fchewingum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlisup%2Fchewingum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlisup%2Fchewingum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karlisup","download_url":"https://codeload.github.com/karlisup/chewingum/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlisup%2Fchewingum/sbom","scorecard":{"id":550459,"data":{"date":"2025-08-11","repo":{"name":"github.com/karlisup/chewingum","commit":"3a0df834cf5988d79d9197e15c82f8bc859f9dd0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 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":"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":"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":"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":"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":"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":"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":"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":"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":0,"reason":"57 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr","Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q","Warn: Project is vulnerable to: GHSA-f98m-q3hr-p5wq","Warn: Project is vulnerable to: GHSA-39q4-p535-c852","Warn: Project is vulnerable to: GHSA-h86x-mv66-gr5q","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-p9wx-2529-fp83","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-h6mq-3cj6-h738","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"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-20T10:42:11.807Z","repository_id":57197848,"created_at":"2025-08-20T10:42:11.807Z","updated_at":"2025-08-20T10:42:11.807Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273094913,"owners_count":25044600,"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-01T02:00:09.058Z","response_time":120,"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":["component-library","css","documentation-generator","pattern-library"],"created_at":"2025-05-26T02:18:07.187Z","updated_at":"2025-09-01T08:50:34.583Z","avatar_url":"https://github.com/karlisup.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://travis-ci.org/karlisup/chewingum\" title=\"Build Status\"\u003e\n   \u003cimg src=\"https://img.shields.io/travis/karlisup/chewingum/master.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://coveralls.io/r/karlisup/chewingum?branch=master\" title=\"Coverage Status\"\u003e\n    \u003cimg src=\"https://img.shields.io/coveralls/karlisup/chewingum.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/chewingum\" title=\"npm\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/chewingum.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/chewingum\" title=\"NPM version\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/chewingum.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://david-dm.org/karlisup/chewingum\" title=\"Dependency Status\"\u003e\n    \u003cimg src=\"https://img.shields.io/david/karlisup/chewingum.svg?style=flat-square\u0026label=deps\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://david-dm.org/karlisup/chewingum#info=devDependencies\" title=\"devDependency Status\"\u003e\n    \u003cimg src=\"https://img.shields.io/david/dev/karlisup/chewingum.svg?style=flat-square\u0026label=devDeps\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://www.github.com/karlisup/chewingum\"\u003e\u003cimg src=\"https://placehold.it/200x125/\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://karlisup.github.io/chewingum/demo/partials/lakeside/lakeside.html\" target=\"_blank\"\u003eDemo\u003c/a\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003eDocumentation generator for Pattern Library.\u003c/p\u003e\n\n## Features\n### Template engine agnostic\nAs it is build upon `node.js` it uses multiple libraries to support various template engines to generate documentation. So far it supported template engines are:\n1. `twig`\n2. TODO `moustache`\n3. TODO `handlebars`\n\n### Use API insted of `Copy`/`Paste`\nYou can build pattern libraries\n1. fast (reuse template, demo data)\n2. documented (have demo right beside documentation)\n3. link it directly into your project\n\nA component (e.g. `lakeside.twig`):\n```twig\n\u003carticle class=\"lakeside {{class}}\"\u003e\n  {% if image %}\n    \u003caside class=\"lakeside__media\"\u003e\n      \u003cimg src=\"image.src\" alt=\"image.alt\"\u003e\n    \u003c/aside\u003e\n  {% endif %}\n  \u003cdiv class=\"lakeside__body\"\u003e\n    \u003cdiv class=\"lakeside__content\"\u003e\n      {% include 'partials/title/title.twig' with title %}\n      {% if summary %}\u003cp class=\"lakeside__summary long-primer\"\u003e{{ summary }}\u003c/p\u003e{% endif %}\n    \u003c/div\u003e\n    \u003cdiv class=\"lakeside__meta\"\u003e\n      {% include 'partials/lists/list-inline.twig' with listItems %}\n    \u003c/div\u003e\n  \u003c/div\u003e\n  \u003ca href=\"#\" class=\"lakeside__link\" aria-hidden=\"true\" tabindex=\"-1\"\u003e{{ title.title }}\u003c/a\u003e\n\u003c/article\u003e\n```\n\nUsage (in `news-feed.twig`):\n```twig\n\u003cdiv class=\"row\"\u003e\n  {% for i in 0..2 %}\n    \u003cdiv class=\"col-sm-4\"\u003e\n      {% include 'partials/lakeside/lakeside.twig' with article %}\n    \u003c/div\u003e\n  {% endfor %}\n\u003c/div\u003e\n```\n\nTest data for demo generation (`lakeside.json`):\n```json\n{\n  \"image\": {\n    \"src\": \"http://placehold.it/800x600/\",\n    \"alt\": \"placeholder\"\n  },\n  \"title\": \"data@partials/title/title.json\",\n  \"listItems\": \"data@partials/lists/list-inline.json\"\n}\n```\n\n### Customisable look\nEvery self-worthy company has their own style guides and design principles they base their designs upon. Chewingum allows you to completely change visual look of the generated documentation to fit your needs.\n\n| Github-like ([Demo](https://karlisup.github.io/chewingum/demo//partials/lakeside/lakeside.html)) |\n| :-----------: |\n| ![Github theme](https://github.com/karlisup/chewingum/blob/gh-pages/images/theme-github-preview.png) |\n\n## Usage\n### Part I\nenough to see Chewingum in action\n```js\n// setting general settings\nvar src = './pattern-library/'\nvar dest = './documentation/'\n\n// gulp modules\nvar gulp = require('gulp')\nvar chewingum = require('chewingum')\nvar browserSync = require('browser-sync').create()\n\n// Pattern Library\n// For each template file (e.g. breadcrumbs.twig) will build a documentation file.\ngulp.task('chewingum', function () {\n  chewingum({\n    location: {\n      src: src,\n      dest: dest\n    }\n  })\n})\n\n// Server\n// Will build server for patter-library\ngulp.task('server', function () {\n  browserSync.init({\n    server: {\n      baseDir: dest\n    },\n    port: 9999,\n    open: false,\n    notify: false\n  })\n})\n```\n\n### Part II\nadd your way to pass style \u0026 JavaScript\n\n```js\n// for STYLE\nvar sass = require('gulp-sass')\nvar postcss = require('gulp-postcss')\nvar autoprefixer = require('autoprefixer')\n\n// for JavaScript\nvar concat = require('gulp-concat')\n\n// Style\n// Will combine and minify all component styles\ngulp.task('style', function (done) {\n  return gulp.src('./sass/style.scss')\n    .pipe(sass().on('error', sass.logError))\n    .pipe(gulp.dest(dest + '/assets/'))\n    .pipe(browserSync.stream())\n})\n\n// JavaScript\n// Will combine and minify all component JavaScript files.\ngulp.task('javascript', function (done) {\n  return gulp.src(src + '/**/*.js')\n    .pipe(concat('components.js'))\n    .pipe(gulp.dest(dest + '/assets/'))\n})\n\n\n\n// FOOTER\n// WATCH\ngulp.task('watch', function (done) {\n  gulp.watch(src + '/**/*.twig', ['chewingum'])\n})\n// DEFAULT\ngulp.task('default', ['chewingum', 'style', 'javascript', 'server', 'watch'])\n```\n\n\n## Options\n### opts.location.src\nType: `String` Default: `src/components/`\n\nSets target for folder from which all the components will be taken.\n\n### opts.location.dest\nType: `String` Default: `dest/components/`\n\nSets target for Pattern Library output location.\n\n### opts.filterItems\nType: `Array` Default: `[]`\n\nPass tabs that filter search results by regular expression. Example: `[{'title': 'Atoms','regex': '01-atoms'}]`.\n\n### opts.location.styleguide\nType: `String` Default: `node_modules/chewingum/doc-template/`\n\nSets target for pattern library templates. It is possible to modify existing pattern library look by moving doc-template to local folder and modifying this URL.\n\n\n## Contribute\nHelp us make this project better - [Contributing guide](/CONTRIBUTING.md)!\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarlisup%2Fchewingum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarlisup%2Fchewingum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarlisup%2Fchewingum/lists"}