README.md

Shaku

釈(Shaku)- elucidate, explain

Shaku is a family of tools to help write technical blogs, out of my frustration while writing articles for my personal blog - jser.dev.

Packages

Core

1. shaku-code-annotate-core - core parser of Shaku. Tokenizer not included.

for Latest Shiki(1.x.x)

Recommended implementation based on Shiki Transformer

1. shaku-code-annotate-shiki-transformer - Shaku syntax transformer for [email protected]

for Legacy Shiki(0.x.x)

Legacy implementation by wrapping shiki.

1. shaku-code-annotate-shiki - Shaku syntax highlighter based on Shiki.
2. remark-shaku-code-annotate - plugin for remark.
3. marked-shaku-code-annotate - plugin for marked.

for Sugar High

1. shaku-code-annotate-sugar-high - Shaku syntax highlighter based on Sugar High.

Tools

1. Shaku Playground - a playground to try out shaku-code-annotate.
2. Shaku Snippet - generate beautiful code snippet screenshots with annotation.

Dev tools

Also with some dev tools if you are interested

1. Shiki Token Inspector - easily inspect the tokens generated by shiki.
2. Sugar High Token Inspector - easily inspect the tokens generated by Sugar High.

Built with Shaku

Check out some cool stuff built with Shaku.

• jser.dev blog is using Shaku heavily to annotate code snippets.
• jser.pro has interactive React quizzes on top of Shaku.
• bfe.dev supports Shaku in its posts.

Community

1. Shaku Discord