{"id":26860430,"url":"https://github.com/fastcomments/fastcomments-docs","last_synced_at":"2026-03-09T04:07:56.644Z","repository":{"id":37387754,"uuid":"337780015","full_name":"FastComments/fastcomments-docs","owner":"FastComments","description":"Documentation and Tutorials for FastComments.","archived":false,"fork":false,"pushed_at":"2026-03-05T06:54:02.000Z","size":55135,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-03-05T11:40:07.706Z","etag":null,"topics":["commenting-system","documentation","live-chat","static-site-generator"],"latest_commit_sha":null,"homepage":"https://docs.fastcomments.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FastComments.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-02-10T16:17:29.000Z","updated_at":"2026-03-05T06:54:07.000Z","dependencies_parsed_at":"2026-01-31T08:09:24.733Z","dependency_job_id":null,"html_url":"https://github.com/FastComments/fastcomments-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/FastComments/fastcomments-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FastComments%2Ffastcomments-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FastComments%2Ffastcomments-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FastComments%2Ffastcomments-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FastComments%2Ffastcomments-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FastComments","download_url":"https://codeload.github.com/FastComments/fastcomments-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FastComments%2Ffastcomments-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30282750,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T02:57:19.223Z","status":"ssl_error","status_checked_at":"2026-03-09T02:56:26.373Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["commenting-system","documentation","live-chat","static-site-generator"],"created_at":"2025-03-31T01:34:07.537Z","updated_at":"2026-03-09T04:07:56.617Z","avatar_url":"https://github.com/FastComments.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fastcomments-docs\n\nDocumentation and Tutorials that lives at https://docs.fastcomments.com\n\n## Contributing\n\nBefore starting work, please open an issue describing the improvement you want to make so that your work is not\nduplicated by accident.\n\nWhen you have something to show - create a pull request!\n\n*Read the Conventions section below!*\n\n## Setup\n\nThis project uses a small framework written in NodeJS. It requires Node 10 or newer.\n\n    npm install\n\n### Setup - Windows\n    \n    npm build-windows\n\n### Setup - Linux/Unix\n\n    npm build-posix\n\n### Run Development Watch Job\n\n    npm run watch\n\n\n### Adding Content\n\n1. In `src/content/guides`, add a folder.\n2. Follow the pattern of the other folders for the file structure (you'll need an `items` directory and a `meta.json` for example).\n\n#### Items Directory\n\nThe `items` directory is where the content for your guide lives.\n\n#### meta.json\n\nThis is a file that describes your guide. Changing it will cause the watch job to rebuild the entire guide.\n\n    {\n      \"name\": \"Moderation\",\n      \"icon\": \"moderator.png\",\n      \"itemsOrdered\": [\n        {\n          \"name\": \"The Moderate Comments Page\",\n          \"file\": \"moderate-comments-page.md\",\n          \"subCat\": \"Introduction\"\n        },\n        ...\n\n\"subCat\" is not referencing any identifier. Simply adding a subCat will create that sub category.\n\n## Conventions\n\n### Screenshots\n\nIn order to keep this documentation easy to maintain, we *absolutely never hard code screenshots*.\n\nInstead, we generate them, for example in your `some-guide-name/items/some-item.md` file:\n\n    [app-screenshot-start url='/auth/my-account/customize-widget/new'; selector = '.max-comment-size'; title='Limit Comment Length' app-screenshot-end]\n\nThis will create a screenshot of `.max-comment-size` on the page `https://fastcomments.com/auth/my-account/customize-widget/new`, and title it `Limit Comment Length`.\n\nThe related code is in `src/app-screenshot-generator`.\n\n### Code Snippets\n\nWhen writing code snippets, it's helpful that you also highlight the section of the code snippet that is important.\n\n    [code-example-start config = {customCSS: \"button { background: red; }\" }; linesToHighlight = [6]; title = 'Passing Custom CSS'; code-example-end]\n\nIn this example, we create a code snippet of the VanillaJS widget and highlight lines 6.\n\nThe related code is in `src/code-example-generator.js`.\n\nWhen updating the `Customizations \u0026 Configuration` documentation, please ensure that you list the parameter you are documenting at\nthe start of your documentation, to be consistent:\n\n    [related-parameter-start name = 'headerHTML'; type = 'string'; related-parameter-end]\n\nIn our code snippets, we prefer to use TypeScript when possible as it is very verbose and easy to read, and if not then JavaScript.\n\nOther languages are allowed when trying to illustrate examples in those languages.\n\n### Grammar\n\nWe suggest using an editor with built in helpers for grammar.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffastcomments%2Ffastcomments-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffastcomments%2Ffastcomments-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffastcomments%2Ffastcomments-docs/lists"}