Skip to content

feat: add theming docs, lightningcss at-rules, and badges to README - #9

Merged
megheaiulian merged 1 commit into
mainfrom
docs/readme-improvements
Jul 29, 2026
Merged

feat: add theming docs, lightningcss at-rules, and badges to README#9
megheaiulian merged 1 commit into
mainfrom
docs/readme-improvements

Conversation

@megheaiulian

Copy link
Copy Markdown
Contributor

Summary

Expands the README with documentation for theming, custom at-rules, and contributing.

Changes

  • Add npm version, CI, and license badges
  • Document @text and @heading lightningcss custom at-rules with examples
  • Add Customization section covering all CSS custom properties:
    • Typography scale (--md-size, --md-lh, etc.)
    • Heading scale (--h-xl-size, --h-xl-ls, etc.)
    • Layout (--row-base, --row-margin)
    • Colors (--color, --link-color, design tokens)
    • Breakpoints (--mobile)
  • Add Contributing section with setup and release info

Why feat: commit type

Using feat: to trigger a minor release (2.8.2 -> 2.9.0) since the README now documents the customization API (CSS variables) and custom at-rules, which is a user-facing documentation enhancement.

- Add npm/CI/license badges
- Document @text and @Heading custom at-rules with examples
- Add Customization section covering typography, headings, layout,
  colors, and breakpoints CSS variables
- Add Contributing section with setup and release info
@megheaiulian
megheaiulian merged commit 0a86fa9 into main Jul 29, 2026
2 checks passed
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 2.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant