{"id":24461304,"url":"https://github.com/frontend-layers/html-pages-preview","last_synced_at":"2025-10-10T18:36:46.442Z","repository":{"id":59272401,"uuid":"535788811","full_name":"Frontend-Layers/html-pages-preview","owner":"Frontend-Layers","description":"Generates one HTML page from defined list of the pages for comfort preview","archived":false,"fork":false,"pushed_at":"2023-04-24T13:27:14.000Z","size":28,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-08T21:07:40.233Z","etag":null,"topics":["automation","generator","html","html-base","nodejs","previewer"],"latest_commit_sha":null,"homepage":"https://rawcdn.githack.com/andreymatin/html-pages-preview/379145ec790928075cd1e38b427034adf46bef8b/dist/preview.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/Frontend-Layers.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-09-12T17:59:12.000Z","updated_at":"2023-05-10T21:10:43.000Z","dependencies_parsed_at":"2024-10-23T01:36:16.079Z","dependency_job_id":null,"html_url":"https://github.com/Frontend-Layers/html-pages-preview","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"379145ec790928075cd1e38b427034adf46bef8b"},"previous_names":["andreymatin/html-pages-preview"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Frontend-Layers/html-pages-preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-pages-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-pages-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-pages-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-pages-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Frontend-Layers","download_url":"https://codeload.github.com/Frontend-Layers/html-pages-preview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-pages-preview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004909,"owners_count":26083803,"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-10-10T02:00:06.843Z","response_time":62,"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":["automation","generator","html","html-base","nodejs","previewer"],"created_at":"2025-01-21T04:18:55.604Z","updated_at":"2025-10-10T18:36:46.411Z","avatar_url":"https://github.com/Frontend-Layers.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HTML Pages Preview\n\n_Merged one HTML page from defined list of the pages/templates for preview_\n\n[![License:MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/andreymatin/html-pages-preview/LICENSE)\n[![npm](https://img.shields.io/npm/v/html-pages-preview.svg)](https://www.npmjs.com/package/html-pages-preview)\n\n## Why\n\nGenerated preview for all pages on the one for test or demonstration purposes\n\n## How to install\n\n### npm\n\n```shell\nnpm i html-pages-preview --save-dev\n```\n\n### yarn\n\n```shell\nyarn html-pages-preview -D\n```\n\n## How to use\n\n```javascript\nconst htmlPreview = require('./lib/merged-html-preview');\n\nconst src = [\n  './dist/article.html',\n  './dist/home.html',\n  './dist/product.html'\n];\n\nconst dest = './dist/preview.html';\n\nhtmlPreview(src, dest)\n```\n\n## Gulp integration\n\n```javascript\nimport gulp from 'gulp';\nconst { parallel, watch } = gulp;\n\nimport htmlPreview from 'html-pages-preview';\n\nconst htmlPagesPreview = (c) =\u003e {\n  const src = [\n    './dist/home.html',\n    './dist/article.html',\n    './dist/product.html'\n  ];\n\n  const dest = './dist/preview.html';\n\n  htmlPreview(src, dest);\n  return c();\n};\n\nconst watcher = () =\u003e {\n  watch('./dist/*.html', htmlPagesPreview);\n};\n\nexport default\n  parallel(\n    htmlPagesPreview,\n    watcher\n  )\n```\n\n## Config parameters\n\n### Default values\n\n```javascript\ncfg = {\n  styles: '',\n  header: 'Pages Preview',\n  toc: true,\n  newtab: true,\n  toggle: true,\n  animation: true,\n  pane: true,\n  title: true,\n  titleDivider: '-',\n  filename: true,\n  baseUrl: '',\n  backToIndex: true,\n  backToIndexUrl: ''\n}\n\nhtmlPreview(src, dest, cfg);\n```\n\n| Value          | Default | Description |\n|----------------|---------|-------------|\n| styles         | ''      | custom CSS for header, panel etc. Initial styles based on bootstrap 5  |\n| header         | 'Pages Preview' | page header |\n| toc            | true | show/hide Table of the content |\n| newtab         | true | show/hide new tab link |\n| toggle         | true | show/hide toggle link |\n| pane           | true | show/hide panel with links and iframe title |\n| title          | true | show/hide panel title |\n| titleDivider   | -    | Divide filename and page tytle by symbol\n| filename       | true | show/hide filename at the panel title |\n| baseUrl        | ./   | Base URL for pages (Default is destination folder) |\n| backToIndex    | true | show/hide back link |\n| backToIndexUrl | ''   | When empty default link is './index.html' |\n\n## Related Projects\n\nI created this and some additional services for [html-base](https://www.npmjs.com/package/html-base) to improve quality of frontend output. Here is the list:\n\n- [scss-reset](https://www.npmjs.com/package/scss-reset)\n- [scss-mixins-npm](https://www.npmjs.com/package/scss-mixins-npm)\n- [mobile-friendly-test-npm](https://www.npmjs.com/package/mobile-friendly-test-npm)\n- [html-speed](https://www.npmjs.com/package/html-speed)\n- [css-test-npm](https://www.npmjs.com/package/css-test-npm)\n\n## Contributing\n\nFor issues, bugs or imporvements please open an [issue](https://github.com/andreymatin/html-pages-preview/issues/new)\n\n\n---\n[MIT License](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontend-layers%2Fhtml-pages-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrontend-layers%2Fhtml-pages-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontend-layers%2Fhtml-pages-preview/lists"}