{"id":19197886,"url":"https://github.com/flarebyte/scratchbook","last_synced_at":"2026-05-17T15:32:40.069Z","repository":{"id":47519862,"uuid":"382811280","full_name":"flarebyte/scratchbook","owner":"flarebyte","description":"Annotation library in Typescript for documentation","archived":false,"fork":false,"pushed_at":"2023-01-23T12:33:34.000Z","size":262,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-25T15:02:05.478Z","etag":null,"topics":["annotations","documentation","npm-package"],"latest_commit_sha":null,"homepage":"https://flarebyte.github.io/scratchbook/","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/flarebyte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-04T09:24:33.000Z","updated_at":"2023-05-13T06:53:41.000Z","dependencies_parsed_at":"2023-02-12T23:00:18.183Z","dependency_job_id":null,"html_url":"https://github.com/flarebyte/scratchbook","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fscratchbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fscratchbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fscratchbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fscratchbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flarebyte","download_url":"https://codeload.github.com/flarebyte/scratchbook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240271540,"owners_count":19774859,"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":["annotations","documentation","npm-package"],"created_at":"2024-11-09T12:19:11.244Z","updated_at":"2025-10-23T18:52:50.255Z","avatar_url":"https://github.com/flarebyte.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scratch Book\n\n![npm](https://img.shields.io/npm/v/scratchbook)\n![Build status](https://github.com/flarebyte/scratchbook/actions/workflows/main.yml/badge.svg)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e8bc221a695648aab31dfa5853d0add7)](https://www.codacy.com/gh/flarebyte/scratchbook/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=flarebyte/scratchbook\u0026utm_campaign=Badge_Grade)\n\n![npm bundle size](https://img.shields.io/bundlephobia/min/scratchbook)\n![Dependencies](https://status.david-dm.org/gh/flarebyte/scratchbook.svg)\n\n![npm type definitions](https://img.shields.io/npm/types/scratchbook)\n![node-current](https://img.shields.io/node/v/scratchbook)\n![NPM](https://img.shields.io/npm/l/scratchbook)\n\n\u003e Scratch Book is an annotation library written in Typescript that makes it easy to write documentation in a decentralized fashion.\n\n- **Typescript** can be used to write the documentation. Integrates perfectly with [ts-node](https://typestrong.org/ts-node/).\n- **No dependency** and lightweight.\n- **Advanced matchers** to query the notes.\n- **Simple model** for the notes that requires very little learning curve while still offering a lot of flexibility.\n- **extensive tests coverage**.\n\n## Usage\n\n```\nconst myScratchBook: ScratchBook = {\n    notes: [\n        createScratchNote('about/scratchbook/description', 'Annotation library'),\n        createScratchNote('about/scratchbook/github', 'scratchbook on github', 'https://github.com/flarebyte/scratchbook'),\n        createScratchNote('about/other/...', 'Some other projects')\n    ]\n}\nfilterScratchBook(withPrefix('about/scratchbook/'))(myScratchBook)\n// will return the description and the github link\n\n```\n\n### Documentation\n\nA detailed documentation for each functions is [available](https://flarebyte.github.io/scratchbook/)\n\n### Installation\n\n    yarn add scratchbook\n\n## License\n\nMIT © [2021 Flarebyte - Olivier Huin]()\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflarebyte%2Fscratchbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflarebyte%2Fscratchbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflarebyte%2Fscratchbook/lists"}