Getting Started
Getting Started
Find the shortest path to installation, your first date, and the main Tarikh API.
Getting Started
If you want the fastest route to a working result, use this section as your entry point.
Choose Your Path
| Need | Go to |
|---|---|
| Install the package | Installation |
| Render your first date | Quick Start |
| Understand what Tarikh covers | Introduction |
| Pick a date style | Formatting |
| Parse, convert digits, or use helpers | Utilities |
| Reach React components and types | Reference |
In Practice
Start with format() if you want a date string.
Use toBanglaCalendar() or toHijriCalendar() if you need the parts as data.
Use fromNow() when relative wording reads better than a fixed date.
Use Tarikh from @coreify/tarikh/react when you want semantic <time>
output in React.
Recommended Flow
- Install Tarikh
- Try the quick-start example
- Move to Formatting or Utilities based on the output you need
- Open Reference when you need React components, types, or examples