{"id":22707486,"url":"https://github.com/aonemd/jazl","last_synced_at":"2025-04-13T12:34:21.455Z","repository":{"id":32589433,"uuid":"134420081","full_name":"aonemd/jazl","owner":"aonemd","description":"GitHub issue based commenting system made simple","archived":false,"fork":false,"pushed_at":"2023-01-06T01:52:03.000Z","size":382,"stargazers_count":9,"open_issues_count":8,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-27T03:35:14.321Z","etag":null,"topics":["babel7","blogging","comments","github","github-pages","issues","postcss","webpack4"],"latest_commit_sha":null,"homepage":"https://aonemd.github.io/jazl/","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/aonemd.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-05-22T13:34:22.000Z","updated_at":"2021-09-06T14:16:33.000Z","dependencies_parsed_at":"2023-01-14T21:45:32.129Z","dependency_job_id":null,"html_url":"https://github.com/aonemd/jazl","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aonemd%2Fjazl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aonemd%2Fjazl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aonemd%2Fjazl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aonemd%2Fjazl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aonemd","download_url":"https://codeload.github.com/aonemd/jazl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248714619,"owners_count":21149927,"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":["babel7","blogging","comments","github","github-pages","issues","postcss","webpack4"],"created_at":"2024-12-10T10:13:08.178Z","updated_at":"2025-04-13T12:34:21.436Z","avatar_url":"https://github.com/aonemd.png","language":"TypeScript","readme":"jazl\n---\n\nGitHub issue based commenting system made simple\n\n[Demo](https://aonemd.github.io/jazl).\n\n### Features\n\n- Built on top of a modern stack: Webpack 4, TypeScript, and PostCSS\n- Supports Markdown\n- More secure as it leaves handling the secret key of GitHub oauth app to the server side\n- Simple and small code base\n\n### Installation\n\n- Deploy [the server app](https://github.com/aonemd/jazl-server) on something like Heroku for example\n- To install the package, run\n```sh\n$ yarn add jazl\n```\n\n- Initialize `Jazl` in your script\n\n```javascript\nimport Jazl from 'jazl';\n\n// import the style theme\nimport 'jazl/dist/jazl.css';\n\nnew Jazl(\n  'github ouath app client id',\n  'the url to the jazl server you deployed',\n  'the id of a hidden tag that contains the issue id/number, e.g., issueId'\n).render();\n  ```\n- Add a comments tag and issueId tag to your markup\n\n```html\n\u003cinput type=\"hidden\" id=\"issueId\" value=\"11\"\u003e\n\u003cdiv id=\"comments\"\u003e\u003c/div\u003e\n```\n- That's it!\n\n### Customization\n\n#### Style\n\nCustomization of the style of each element is possible by overriding the CSS\nrules of the element. The current available rules are as follows:\n\n- `#jazl__editor-container`: the container of the comment editor\n- `#jazl__editor-container #jazl__editor-header`: the header of the comment editor. It has a single rule:\n  * `#jazl__editor-container #jazl__editor-header a`: the anchor in the header element\n- `#jazl__editor-container #jazl__editor`: the main comment editor\n- `#jazl__editor-container #jazl__comment-button`: the comment submit button\n- `.jazl__comment`: the container of a single comment\n- `.jazl__comment .jazl__comment-header`: the header of a comment. It contains:\n  * `.jazl__comment .jazl__comment-header a`: the link of the username\n  * `.jazl__comment .jazl__comment-header img`: the image of the user\n- `.jazl__comment .jazl__comment-body`: the actual comment body. It contains one rule:\n  * `.jazl__comment .jazl__comment-body img`: the element of the attached images\n\n### License\n\nSee [LICENSE](https://github.com/aonemd/jazl/blob/master/LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faonemd%2Fjazl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faonemd%2Fjazl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faonemd%2Fjazl/lists"}