https://github.com/expressive-code/annotation-comments
https://github.com/expressive-code/annotation-comments
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/expressive-code/annotation-comments
- Owner: expressive-code
- License: mit
- Created: 2024-08-05T22:33:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T11:16:39.000Z (about 1 year ago)
- Last Synced: 2025-10-19T19:25:57.304Z (4 months ago)
- Language: TypeScript
- Size: 239 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# annotation-comments
This library provides functionality to parse and extract annotation comments from code snippets.
Annotation comments allow authors to annotate pieces of source code with additional information (e.g. marking important lines, highlighting changes, adding notes, and more) while keeping it readable and functional:
````mdx ignore-tags
```js
// [!note] The note explains the `console.log(...)` line
console.log('Some code');
// The next line will be marked as inserted
newCode(); // [!ins]
```
````
While this library was originally developed for the documentation tool [Expressive Code](https://expressive-code.com), the annotation comment syntax is designed to be compatible with Shiki's common transformer syntax and extend its functionality. It was intentionally decoupled from Expressive Code to allow other tools to use it as well.
## When should I use this?
Using this package directly is only recommended if you are building a custom documentation tool or want to integrate annotation comments into your own workflow.
If you are looking for a ready-to-use solution that uses this package to support annotation comments in code snippets, check out [Expressive Code](https://expressive-code.com) instead.
## Installation, Usage & API
For installation instructions, usage examples, and the full API documentation of the main library package, please refer to the [package's README](packages/annotation-comments/README.md).