Where to Find RoughNotation's Code, Documentation, and Support
Updated
RoughNotation's code and documentation are on GitHub, and the project page links there directly. The same page also points to a sponsorship option on GitHub and to the author on Twitter at @preetster for contact. If you need the source, usage docs, or a way to reach the maintainer, those three destinations cover it.
Code and documentation
The RoughNotation site states that all the code and documentation is available on GitHub, with a "View on Github" link. That single link is the canonical entry point for both:
- Source code — the library itself, described as a small JavaScript library for creating and animating hand-drawn annotations on a web page.
- Documentation — the reference material for the annotation styles and configuration options shown on the site.
If you are evaluating the library before installing it, the GitHub repository is also where you would confirm the current API and any changes since the site content was written.
Support and contact
The site offers two ways to engage with the project beyond reading the code:
| Purpose | Where to go |
|---|---|
| Report issues, ask questions, contribute | GitHub repository (linked from the site) |
| Sponsor the project | GitHub sponsorship (linked from the site) |
| Reach the author | Twitter: @preetster |
The site does not list a separate forum, chat server, or email address, so GitHub and Twitter are the channels it actually points to.
What you'll find once you're there
The documentation covers the annotation styles the library supports, which is useful context for deciding whether it fits your project. The site lists these styles:
- Underline — a sketchy underline below an element
- Box — a box drawn around the element
- Circle — a circle around the element
- Highlight — a highlighter-style effect
- Strike-Through — a hand-drawn line through an element
- Crossed-Off — a crossed-off effect, described as symbolizing rejection
- Brackets — a hand-drawn bracket on one or multiple sides of a block, such as a paragraph
- Multiple lines — annotation of inline content that spans multiple lines
Beyond styles, the docs also cover ordering animations through an annotation group (pass a list of annotations to create a group; calling show on the group animates them in order), styling properties such as color, strokeWidth, and animation duration, and the option to skip animation entirely so an annotation simply appears when show is called.
Practical notes
- The site describes RoughNotation as a small JavaScript library, so the GitHub README is likely to be short — expect the documentation to be a single reference page rather than a large docs site.
- The site does not state pricing or licensing terms in the material available here. Check the GitHub repository for the license and any current terms rather than assuming.
- If you only need to confirm a style name or a configuration property, the project page itself may be faster than the repository; go to GitHub when you need the actual code or want to file an issue.