Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ragaeeb/paragrafs/llms.txt

Use this file to discover all available pages before exploring further.

​
Current Version

Version 1.6.0

The latest stable release of Paragrafs

​
Release Notes

For detailed release notes, including new features, bug fixes, and breaking changes for each version, visit the GitHub releases page:

View All Releases on GitHub

Complete changelog with detailed release notes for every version

​
Recent Changes

​
Breaking Changes

The latest version includes important breaking changes:
If you’re upgrading from an older version, please review the Migration Guide for detailed upgrade instructions.
createHints(...) now uses Arabic-first normalization for matching and mining. If you relied on exact string matching, update your expectations and/or pass explicit normalization options.Reference: src/utils/textUtils.ts:121-156
Segments or lines after an ALWAYS_BREAK must not be merged into previous segments. This creates an absolute boundary in segment processing.Reference:

​
Version Information

​
Package Details

Current Version

1.6.0

License

MIT

Package Name

paragrafs

Module Format

ESM

​
Engine Requirements

"bun": ">=1.3.5"

​
Semantic Versioning

Paragrafs follows Semantic Versioning (semver):
  • Major version (X.0.0) - Breaking changes that require migration
  • Minor version (0.X.0) - New features, backwards compatible
  • Patch version (0.0.X) - Bug fixes, backwards compatible
Pin to specific versions in your package.json to avoid unexpected breaking changes:
{
  "dependencies": {
    "paragrafs": "1.6.0"
  }
}

​
Staying Updated

​
GitHub Releases

The most comprehensive source for version history:
  • Release notes for each version
  • Detailed changelogs with all changes
  • Download links for specific versions
  • Git tags for version tracking

Watch on GitHub

Star and watch the repository to get notified about new releases

​
NPM Registry

Check package versions on npm:

View on npm

See all published versions and download statistics

​
Upgrading

To upgrade to the latest version: 
npm install paragrafs@latest
Always review the Migration Guide before upgrading major versions to understand breaking changes.

​
Release Process

Paragrafs uses automated semantic release for version management:
  1. Automated versioning based on conventional commits
  2. Automated changelog generation
  3. Automated npm publishing
  4. Automated GitHub releases
The project uses semantic-release to automate the release workflow.

​
Contributing to Releases

If you’re contributing to Paragrafs:
  • Follow conventional commit format
  • Use feat: for new features (minor version bump)
  • Use fix: for bug fixes (patch version bump)
  • Use BREAKING CHANGE: in commit body for breaking changes (major version bump)
Learn more in the Contributing Guide.

​
Need Help?

Migration Guide

Learn how to upgrade between versions

Report Issues

Found a bug? Let us know on GitHub