{"id":17026037,"url":"https://github.com/JSerZANP/shaku","last_synced_at":"2026-04-13T01:30:18.645Z","repository":{"id":164871583,"uuid":"635366027","full_name":"JSerZANP/shaku","owner":"JSerZANP","description":"Shaku helps you write better technical articles with code annotation .etc","archived":false,"fork":false,"pushed_at":"2024-07-18T14:20:58.000Z","size":1156,"stargazers_count":219,"open_issues_count":15,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-13T01:03:03.766Z","etag":null,"topics":["annotation-tool","code-annotation","code-blocks","documentation-tool","remark-plugin","syntax-highlighting"],"latest_commit_sha":null,"homepage":"https://shaku-web.vercel.app","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/JSerZANP.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}},"created_at":"2023-05-02T14:38:58.000Z","updated_at":"2024-10-11T14:17:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"e62bd34d-60e3-45e3-b7ea-126fb04a6fae","html_url":"https://github.com/JSerZANP/shaku","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/JSerZANP%2Fshaku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JSerZANP%2Fshaku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JSerZANP%2Fshaku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JSerZANP%2Fshaku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JSerZANP","download_url":"https://codeload.github.com/JSerZANP/shaku/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219855248,"owners_count":16556176,"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":["annotation-tool","code-annotation","code-blocks","documentation-tool","remark-plugin","syntax-highlighting"],"created_at":"2024-10-14T07:30:22.926Z","updated_at":"2026-04-13T01:30:18.562Z","avatar_url":"https://github.com/JSerZANP.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Shaku\n\n\u003e \u003cruby\u003e釈\u003crp\u003e(\u003crp\u003e\u003crt\u003eShaku\u003c/rt\u003e\u003crp\u003e)\u003crp\u003e\u003c/ruby\u003e- _elucidate, explain_\n\nShaku is a family of tools to help write technical blogs,\nout of my frustration while writing articles for my personal blog - [jser.dev](https://jser.dev).\n\n## Packages\n\n### Core\n\n1. [shaku-code-annotate-core](./packages/shaku-code-annotate-core/) - core parser of Shaku. Tokenizer not included.\n\n### for Latest Shiki(1.x.x)\n\nRecommended implementation based on [Shiki Transformer](https://shiki.matsu.io/guide/transformers)\n\n1. [shaku-code-annotate-shiki-transformer](./packages/shaku-code-annotate-shiki-transformer/) - Shaku syntax transformer for Shiki@1.x.x\n\n### for Legacy Shiki(0.x.x)\n\nLegacy implementation by wrapping shiki.\n\n1. [shaku-code-annotate-shiki](./packages/shaku-code-annotate-shiki/) - Shaku syntax highlighter based on Shiki.\n2. [remark-shaku-code-annotate](./packages/remark-shaku-code-annotate/) - plugin for remark.\n3. [marked-shaku-code-annotate](./packages/marked-shaku-code-annotate/) - plugin for marked.\n\n### for Sugar High\n\n1. [shaku-code-annotate-sugar-high](./packages/shaku-code-annotate-sugar-high/) - Shaku syntax highlighter based on Sugar High.\n\n## Tools\n\n1. [Shaku Playground](https://shaku-web.vercel.app/playground) - a playground to try out shaku-code-annotate.\n2. [Shaku Snippet](https://shaku-web.vercel.app/snippet) - generate beautiful code snippet screenshots with annotation.\n\n## Dev tools\n\nAlso with some dev tools if you are interested\n\n1. [Shiki Token Inspector](https://shaku-web.vercel.app/shiki-token-inspector) - easily inspect the tokens generated by [shiki](https://github.com/shikijs/shiki).\n2. [Sugar High Token Inspector](https://shaku-web.vercel.app/sugar-high-token-inspector) - easily inspect the tokens generated by [Sugar High](https://github.com/huozhi/sugar-high).\n\n## Built with Shaku\n\nCheck out some cool stuff built with Shaku.\n\n- [jser.dev blog](https://jser.dev/2024-03-20-how-does-useoptimisticwork-internally-in-react/) is using Shaku heavily to annotate code snippets.\n- [jser.pro](https://jser.pro/ddir/quiz) has interactive React quizzes on top of Shaku.\n- [bfe.dev](https://bigfrontend.dev/problem/39/discuss/2363?focus=26638) supports Shaku in its posts.\n\n## Community\n\n1. [Shaku Discord](https://discord.gg/bFh8EzW7kv)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJSerZANP%2Fshaku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJSerZANP%2Fshaku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJSerZANP%2Fshaku/lists"}