home projects
A zero dependency package to highlight elements

Speccer is a zero dependency JavaScript package to highlight elements on web pages and in documentation. It's easy to use and highly customizable, making it the perfect tool for developers, designers, and content creators alike.

Get Started GitHub npm

About Speccer

Speccer was originally created to make it easier to document components in a design system, but you can use it for whatever you like, whenever you need to highlight any element in your web projects.

With speccer, you can highlight any element on a web page or in documentation with pins, markers, arrows, and more. This can be useful for a variety of purposes, such as:

  • Showcasing the different parts of a component or design system
  • Documenting how to use a particular element or feature
  • Drawing attention to important information
  • Creating interactive tutorials or demos

Speccer is incredibly easy to use. Simply add the data-speccer (or other tagsf or other features) attribute to any element you want to highlight, and speccer will do the rest. You can also customize the look and feel of speccer to match your own branding or style guide.

See It in Action

View Demo

Key Features

Element Spacing

Easily display padding and margin for any element in your projects.

Element Dimensions

Measure and highlight the width and height of elements with various placement options.

Highlight Anatomy

Pin elements to the outline of an element to showcase its structure.

Highlight Typography

Shows the typography of a given element.

Highlight Elements

Mark elements to reference them.

Other features

  • Zero dependencies
  • Open source
  • Easy to use
  • Highly customizable
  • Supports a variety of highlight types, including pins, markers, arrows, and more
  • Can be used on web pages and in documentation

Benefits

  • Improve the clarity and readability of your web pages and documentation
  • Make it easier for users to understand how to use your products and services
  • Create more engaging and interactive tutorials and demos

Get Started

Ready to enhance your documentation and web projects? Follow these simple steps to get started with speccer:

  1. Install speccer via npm:
  2. npm i @phun-ky/speccer
  3. Choose your preferred integration method, whether it's Typescript, ESM, Script, or React.
  4. Customize the styling to match your project's design.

It is always up to date

Speccer is always up to date, ensured to you by the author!

Used by

API Documentation

For a detailed understanding of speccer's API, refer to the API Documentation.

Customization

Speccer offers flexibility in styling. You can customize its look and feel using CSS variables or apply CSS overrides to match your project's design preferences.


About the author

Hi! My name is Alexander, and I am a creative frontender, specializing in UX, accessibility, universal design, frontend-architecture, node and design systems. I am passionate with open source projects and love to dabble with new emerging technologies related to frontend. With over 24 years of frontend experience, I have earned the right to be called a veteran. I am a lover of life, technologist at heart. If I am not coding, I am cooking and I love whisky and cigars. Oh, and coffee, I LOVE coffee!

If you want to know more about me, here is some links you might want to check out: GitHub, Instagram, Twitter, LinkedIn, CodePen, Slides.com, npm,

Speaker

I am also an avid speaker on several topics! Check out some of the things I speak about, and contact me if you are interested in having me at your next event!