{"id":17351138,"url":"https://github.com/polytypic/klipse-github-docs-generator","last_synced_at":"2025-07-13T03:33:37.962Z","repository":{"id":78838699,"uuid":"92433822","full_name":"polytypic/klipse-github-docs-generator","owner":"polytypic","description":"Generates HTML pages with Klipse snippets from GitHub markdown","archived":false,"fork":false,"pushed_at":"2019-12-22T09:40:33.000Z","size":35,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-18T19:48:43.802Z","etag":null,"topics":["docs","github","klipse"],"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/polytypic.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,"zenodo":null}},"created_at":"2017-05-25T18:45:10.000Z","updated_at":"2019-06-28T09:01:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"1f917b98-c6c6-471f-b318-9a182efd11f2","html_url":"https://github.com/polytypic/klipse-github-docs-generator","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/polytypic/klipse-github-docs-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polytypic%2Fklipse-github-docs-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polytypic%2Fklipse-github-docs-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polytypic%2Fklipse-github-docs-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polytypic%2Fklipse-github-docs-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/polytypic","download_url":"https://codeload.github.com/polytypic/klipse-github-docs-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polytypic%2Fklipse-github-docs-generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261049101,"owners_count":23102518,"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":["docs","github","klipse"],"created_at":"2024-10-15T17:09:02.464Z","updated_at":"2025-07-13T03:33:37.952Z","avatar_url":"https://github.com/polytypic.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Klipse GitHub Docs Generator \u0026middot; [![GitHub stars](https://img.shields.io/github/stars/polytypic/klipse-github-docs-generator.svg?style=social)](https://github.com/polytypic/klipse-github-docs-generator) [![npm](https://img.shields.io/npm/dm/klipse-github-docs-generator.svg)](https://www.npmjs.com/package/klipse-github-docs-generator)\n\nThis is a minimalistic tool to generate HTML pages with\n[Klipse](https://github.com/viebel/klipse) snippets from GitHub markdown.\n\nExamples:\n* [Fastener](https://polytypic.github.io/fastener/)\n* [Partial Lenses Validation](https://calmm-js.github.io/partial.lenses.validation/)\n\nThis tool is still rough around the edges.  Feel free to contribute\nimprovements!\n\n[![npm version](https://badge.fury.io/js/klipse-github-docs-generator.svg)](http://badge.fury.io/js/klipse-github-docs-generator)\n[![](https://david-dm.org/polytypic/klipse-github-docs-generator.svg)](https://david-dm.org/polytypic/klipse-github-docs-generator) [![](https://david-dm.org/polytypic/klipse-github-docs-generator/dev-status.svg)](https://david-dm.org/polytypic/klipse-github-docs-generator?type=dev)\n\n## Usage\n\nFirst of all you need to have a GitHub markdown file with the documentation that\nincludes the snippets that you want to klipsify.  See\n[here](https://github.com/polytypic/fastener/blob/master/README.md) for an\nexample.  The essential part is having code snippets in the markdown that can be\nevaluated in a browser \u0026mdash; like this:\n\n```js\n1 + 2\n// 3\n```\n\nClick\n[here](https://polytypic.github.io/klipse-github-docs-generator/index.html#usage)\nto evaluate the above in the browser.\n\nImport statements do not work and you should have those marked in a different\nlanguage.  Like this:\n\n```jsx\nimport from 'some-awesome-library'\n```\n\n### Install `klipse-github-docs-generator`\n\nInstall `klipse-github-docs-generator` as a dev dependency:\n\n```bash\nnpm i --save-dev klipse-github-docs-generator\n```\n\n### `klipse-github-docs.config.js`\n\nTo configure the generator the project root needs to have a file named\n`klipse-github-docs.config.js`, which must be a JavaScript file that must\ncontain a single function that returns an array of configuration objects.  See\n[here](https://github.com/polytypic/fastener/blob/master/klipse-github-docs.config.js)\nfor an example.\n\n### Generate docs\n\nTo generate `docs` you run the command:\n\n```bash\nnpx klipse-github-docs-generator\n```\n\nYou can also implement your own npm scripts to e.g. watch files to rebuild docs\nand reload browser to make editing feedback faster.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolytypic%2Fklipse-github-docs-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolytypic%2Fklipse-github-docs-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolytypic%2Fklipse-github-docs-generator/lists"}