# Koyomi Calendars 暦 — calendar-page icons as SVG

> Koyomi 暦: calendar-page icons as SVG, 18 original designs in light and dark, in any language through Intl. No image, no font, no dependency; import one design alone for a few kilobytes.

Install with `npm install @johnmorrisdotca/koyomi-calendars`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/koyomi-calendars/docs/. The examples on the reference pages are run when the site is built, and what they print is shown under them.

## Guides

- [Getting started](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/getting-started.md): Draw your first calendar-page icon, a month page and a page turn, in a few minutes, with no dependency and no build step beyond your own.
- [Icons and designs](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/icons-and-designs.md): The 18 calendar-page designs, how to choose one by name, the older names that still work, and every option of calendarIcon.
- [Housing, rings and turn](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/looks.md): Set an icon on a disc, bind it with spiral rings, stand it a little askew, or take one of the five named presets that bundle those looks.
- [Month pages](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/month-pages.md): Draw a whole month as a poster, a memo board, a wall page or a desk pad, with a week start, notes of your own, and the grid as data.
- [Turning the page](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/turning-the-page.md): Turn the icon from one day to the next or back in four ways, with date helpers, reduced motion respected, and the options of flipCalendar.
- [The Japanese calendar](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/japanese-calendar.md): Japanese public holidays, old calendar dates and the six-day cycle, computed and never looked up, on the tear-off pages and as plain functions.
- [Languages and locales](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/languages-and-locales.md): Month and weekday words in any language the browser or Node knows, how Japanese, Chinese and Korean change the order, and what happens with a locale that is not known.
- [Frameworks and servers](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/frameworks.md): Put an icon or a month page in plain HTML, React, Vue, Svelte or Angular, render it on a server or to a file, and turn the page from a component.
- [Plain HTML and a CDN](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/html-and-cdn.md): Draw an icon on a page with no build step, from jsDelivr or unpkg, load one design alone, and turn the page from a button.
- [Vite and webpack](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/bundlers.md): Use the package in a Vite or webpack project, import one design alone so the bundle stays small, and check what reached the bundle.
- [Embed it with an iframe](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/embed-in-an-iframe.md): Put a calendar icon or a month in any page with one iframe and no script, and choose what it shows in the address.
- [TypeScript and Node](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/typescript-and-node.md): Use the package's types, draw icons and month pages on a server or in a build script, and write them to files.
- [Sizes and bundles](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/sizes-and-bundles.md): What each import costs a page, how to import one design alone, why nothing else comes with it, and the byte budgets that CI holds.
- [Accessibility and theming](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/accessibility-and-theming.md): What every icon and month page says to a screen reader, how light and dark work, what reduced motion does, and what you can and cannot change in a drawing.
- [Architecture](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/architecture.md): How the package is split into small imports, what a design is, how a drawing is made, and the rules that keep the output, the sizes and the originality fixed.
- [Troubleshooting and FAQ](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/troubleshooting.md): Fixes for a RangeError, a wrong weekday or an empty column, rings that do not show, a flip that does nothing, a locale that comes out in English, and other questions.
- [Upgrading](https://johnmorrisdotca.github.io/koyomi-calendars/docs/guides/upgrading.md): What changed in each version that you must act on, how to move from meigen-sports' calendar icons, and the names that still work.

## Reference

- [@johnmorrisdotca/koyomi-calendars/japanese](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/japanese/index.md): The Japanese calendar facts a date page can show, computed and never looked up: the public holidays (国民の祝日, kokumin no shukujitsu), the old calendar date (旧暦, kyūreki, the lunisolar calendar of the Tenpō era's rules) and the six-day cycle (六曜, rokuyō).
- [@johnmorrisdotca/koyomi-calendars/names](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/names/index.md): /names
- [@johnmorrisdotca/koyomi-calendars/month](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/month/index.md): /month
- [@johnmorrisdotca/koyomi-calendars/animate](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/animate/index.md): /animate
- [@johnmorrisdotca/koyomi-calendars/themes/pins](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-pins/index.md): /themes/pins
- [@johnmorrisdotca/koyomi-calendars/themes/loops](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-loops/index.md): /themes/loops
- [@johnmorrisdotca/koyomi-calendars/themes/shadow](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-shadow/index.md): /themes/shadow
- [@johnmorrisdotca/koyomi-calendars/themes/heavy](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-heavy/index.md): /themes/heavy
- [@johnmorrisdotca/koyomi-calendars/themes/cartoon](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-cartoon/index.md): /themes/cartoon
- [@johnmorrisdotca/koyomi-calendars/themes/flip](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-flip/index.md): /themes/flip
- [@johnmorrisdotca/koyomi-calendars/themes/stack](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-stack/index.md): /themes/stack
- [@johnmorrisdotca/koyomi-calendars/themes/line](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-line/index.md): /themes/line
- [@johnmorrisdotca/koyomi-calendars/themes/curl](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-curl/index.md): /themes/curl
- [@johnmorrisdotca/koyomi-calendars/themes/soft](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-soft/index.md): /themes/soft
- [@johnmorrisdotca/koyomi-calendars/themes/desk](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-desk/index.md): /themes/desk
- [@johnmorrisdotca/koyomi-calendars/themes/thin](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-thin/index.md): /themes/thin
- [@johnmorrisdotca/koyomi-calendars/themes/frame](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-frame/index.md): /themes/frame
- [@johnmorrisdotca/koyomi-calendars/themes/badge](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-badge/index.md): /themes/badge
- [@johnmorrisdotca/koyomi-calendars/themes/sun](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-sun/index.md): /themes/sun
- [@johnmorrisdotca/koyomi-calendars/themes/roll](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-roll/index.md): /themes/roll
- [@johnmorrisdotca/koyomi-calendars/themes/squircle](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-squircle/index.md): /themes/squircle
- [@johnmorrisdotca/koyomi-calendars/themes/plain](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/themes-plain/index.md): /themes/plain
- [@johnmorrisdotca/koyomi-calendars](https://johnmorrisdotca.github.io/koyomi-calendars/docs/api/main/index.md): Calendar icons

## Optional

- [Changelog](https://johnmorrisdotca.github.io/koyomi-calendars/docs/changelog.md): every release
- [Every export, in full](https://johnmorrisdotca.github.io/koyomi-calendars/llms-full.txt)
- [Source](https://github.com/johnmorrisdotca/koyomi-calendars)