{"id":15016429,"url":"https://github.com/myxotod/eleventy-plugin-readingtime","last_synced_at":"2026-01-03T03:44:00.691Z","repository":{"id":239646858,"uuid":"800130239","full_name":"MyXoToD/eleventy-plugin-readingtime","owner":"MyXoToD","description":"Lightweight 11ty plugin with no dependencies to display page/post reading time","archived":false,"fork":false,"pushed_at":"2024-05-22T06:50:27.000Z","size":42,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-22T05:18:18.531Z","etag":null,"topics":["eleventy","eleventy-plugin","plugin","reading","reading-speed","wordcount"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@myxotod/eleventy-plugin-readingtime","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MyXoToD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"makkusudev","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2024-05-13T18:55:15.000Z","updated_at":"2024-08-18T06:54:57.000Z","dependencies_parsed_at":"2024-05-22T07:45:21.845Z","dependency_job_id":"3930b046-cb1c-4adf-a224-833cec54e964","html_url":"https://github.com/MyXoToD/eleventy-plugin-readingtime","commit_stats":{"total_commits":12,"total_committers":2,"mean_commits":6.0,"dds":0.08333333333333337,"last_synced_commit":"5977bd69fe1a3f6b7386427cdb53ed4f29d6582b"},"previous_names":["myxotod/eleventy-plugin-readingtime"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyXoToD%2Feleventy-plugin-readingtime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyXoToD%2Feleventy-plugin-readingtime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyXoToD%2Feleventy-plugin-readingtime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyXoToD%2Feleventy-plugin-readingtime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MyXoToD","download_url":"https://codeload.github.com/MyXoToD/eleventy-plugin-readingtime/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814895,"owners_count":20352038,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eleventy","eleventy-plugin","plugin","reading","reading-speed","wordcount"],"created_at":"2024-09-24T19:48:52.120Z","updated_at":"2026-01-03T03:44:00.686Z","avatar_url":"https://github.com/MyXoToD.png","language":"JavaScript","funding_links":["https://ko-fi.com/makkusudev"],"categories":[],"sub_categories":[],"readme":"# eleventy-plugin-readingtime\n\nA lightweight [eleventy](https://11ty.dev) plugin to display page/post reading time in minutes. No dependencies.\n\n![NPM Version](https://img.shields.io/npm/v/@myxotod/eleventy-plugin-readingtime.svg) ![NPM Downloads](https://img.shields.io/npm/d18m/%40myxotod%2Feleventy-plugin-readingtime) ![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/min/%40myxotod/eleventy-plugin-readingtime/2.0.0)\n\n\n## Usage\n\nInstall this package\n\n```sh\nnpm i @myxotod/eleventy-plugin-readingtime\n```\n\nAdd and register it inside your `.eleventy.js` config file\n\n```js\n// .eleventy.js\nconst readingtime = require(\"@myxotod/eleventy-plugin-readingtime\");\n\nmodule.exports = (eleventyConfig) =\u003e {\n  eleventyConfig.addPlugin(readingtime);\n};\n```\n\nFinally use it in your code with the `readingtime`-filter\n\n```html\n\u003cdiv\u003eReading time: {{ post | readingtime }}\u003c/div\u003e\n```\n\nExample output\n\n```html\n\u003cdiv\u003eReading time: ~3min\u003c/div\u003e\n```\n\nYou will have to pass the whole post or page to the filter as shown above.\n\n## Options\n\nYou can pass several options when adding the plugin in your eleventy config file like so:\n\n```js\neleventyConfig.addPlugin(readingtime, {\n  wordsPerMinute: 200,\n  suffixDisplay: true,\n  suffixText: 'min',\n  prefixDisplay: true,\n  prefixText: '~',\n  verbose: false\n});\n```\n\n| Option | Default | Description |\n|--------|---------|-------------|\n|`wordsPerMinute`|`200`|Average number of words read per minute (higher values result in faster reading times)|\n|`suffixDisplay`|`true`|Show or hide the suffix|\n|`suffixText`|`'min'`|The suffix to be shown|\n|`prefixDisplay`|`true`|Show or hide the prefix|\n|`prefixText`|`'~'`|The prefix to be shown|\n|`verbose`|`false`|Output additional data to your terminal when an eleventy build happens|\n\n## License\n\n[MIT](https://github.com/MyXoToD/eleventy-plugin-readingtime/blob/main/LICENSE) @ [Maximilian Boll](https://makkusu.dev)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyxotod%2Feleventy-plugin-readingtime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmyxotod%2Feleventy-plugin-readingtime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyxotod%2Feleventy-plugin-readingtime/lists"}