{"id":15849321,"url":"https://github.com/dolanmiu/docsify-sign-off-sheet","last_synced_at":"2025-08-18T19:08:37.922Z","repository":{"id":143548214,"uuid":"615848002","full_name":"dolanmiu/docsify-sign-off-sheet","owner":"dolanmiu","description":"Sign-off Sheet for Docsify Documentation","archived":false,"fork":false,"pushed_at":"2023-04-15T01:04:02.000Z","size":442,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-07T00:02:01.261Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dolanmiu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-03-18T21:11:42.000Z","updated_at":"2024-05-26T06:00:52.000Z","dependencies_parsed_at":"2024-01-07T21:45:28.001Z","dependency_job_id":"a01f04d5-06cc-4030-b31b-361e4735b141","html_url":"https://github.com/dolanmiu/docsify-sign-off-sheet","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/dolanmiu/docsify-sign-off-sheet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolanmiu%2Fdocsify-sign-off-sheet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolanmiu%2Fdocsify-sign-off-sheet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolanmiu%2Fdocsify-sign-off-sheet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolanmiu%2Fdocsify-sign-off-sheet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dolanmiu","download_url":"https://codeload.github.com/dolanmiu/docsify-sign-off-sheet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dolanmiu%2Fdocsify-sign-off-sheet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271043837,"owners_count":24689835,"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-08-18T02:00:08.743Z","response_time":89,"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":[],"created_at":"2024-10-05T18:40:35.047Z","updated_at":"2025-08-18T19:08:37.884Z","avatar_url":"https://github.com/dolanmiu.png","language":"TypeScript","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"# docsify-sign-off-sheet 📝\n\n[![](https://data.jsdelivr.com/v1/package/npm/docsify-sign-off-sheet/badge)](https://www.jsdelivr.com/package/npm/docsify-sign-off-sheet)\n\nA docsify plugin to add sign-off sheets to your docs\n\nThis plugin is an effort to create relevant, up to date documentation for your project. It is a simple plugin that adds a sign-off sheet to your docs. It is a simple way to ensure that your documentation is up to date and relevant.\n\nIt works by setting two items on each documentation page:\n\n1. Review Cadence - How often the documentation should be reviewed\n2. Sign-Off Sheet - A list of people who have reviewed the documentation and the respective date it is reviewed at.\n3. This plugin will do its magic and create a nice display to show the up to date status of the documentation!\n\n## What is a Sign-Off Sheet?\n\n\u003e A sign-off sheet is a business document that confirms two or more parties agree on the status of a project or goal. Sign-off sheets require signatures from the relevant individuals, or stakeholders, to acknowledge they have both reviewed the matter at hand and are satisfied. Organizations save sign-off sheets as proof that they have fulfilled obligations to employees, other businesses and clients.\n\nIt is inspired by the Sign-Off Sheets used by cleaners in restrooms to ensure that the restroom is clean and ready for use.\n\n## Screenshots\n\nWhat's added:\n\n![](https://i.imgur.com/taFlnNR.png)\n\nWhen viewing the Sign-Off sheet:\n\n![](https://i.imgur.com/koSVb5G.png)\n\n## Installation\n\nAdd the `docsify-sign-off-sheet` plugin to your `index.html` after `docsify`. The plugin is available on `jsdelivr` (below), `unpkg`, and other CDN services that auto-publish `npm packages`.\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/docsify-sign-off-sheet\"\u003e\u003c/script\u003e\n```\n\n## Usage\n\n1. Create a sign-off sheet block\n   ```markdown\n   \u003c!-- sign-off-sheet:start --\u003e\n   \u003c!-- sign-off-sheet:end --\u003e\n   ```\n2. Add a sign-off cadence. This can be anywhere in the document. But adding it inside the sign-off sheet block is recommended for easy viewing and maintaining.\n\n   ```markdown\n   ...\n\n   \u003c!-- sign-off-cadence:1 month --\u003e\n\n   ...\n   ```\n\n3. Add a table inside the sign-off sheet block. This is where the sign-off sheet will be displayed. This table can be any format you want, this plugin is smart enough to figure it out. The only requirement is that there is a date in each row. The date supports natural language, so write it in any format you wish!\n\n## Example\n\n```markdown\n\u003c!-- sign-off-sheet:start --\u003e\n\n\u003c!-- sign-off-cadence:1 month --\u003e\n\nThis is the Sign-Off page for the documentation in this repository. Once you have read and understood the documentation, please sign-off by adding your name and date below.\n\n| Name  | Date            |                        Notes |\n| ----- | --------------- | ---------------------------: |\n| Bob   | 5th Nov 1999    |             Looking all good |\n| Alice | 01/31/2000      |           Looking fine by me |\n| Eve   | 2001-06-16      |             Looks good to me |\n| Ryo   | August 4th 2002 | Absolutely fine. Signing off |\n| Ryo   | 17/08/2003      |       No issues, signing off |\n\n\u003c!-- sign-off-sheet:end --\u003e\n```\n\n---\n\nMade with ❤️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdolanmiu%2Fdocsify-sign-off-sheet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdolanmiu%2Fdocsify-sign-off-sheet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdolanmiu%2Fdocsify-sign-off-sheet/lists"}