{"id":16256951,"url":"https://github.com/prazdevs/gatsby-plugin-reading-time-2","last_synced_at":"2025-04-08T13:34:24.661Z","repository":{"id":44151100,"uuid":"418585118","full_name":"prazdevs/gatsby-plugin-reading-time-2","owner":"prazdevs","description":"📰 Gatsby plugin for reading-time integration","archived":false,"fork":false,"pushed_at":"2021-10-18T17:22:51.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T09:54:11.936Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/prazdevs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-18T16:36:47.000Z","updated_at":"2021-10-23T16:45:44.000Z","dependencies_parsed_at":"2022-09-05T06:41:15.274Z","dependency_job_id":null,"html_url":"https://github.com/prazdevs/gatsby-plugin-reading-time-2","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prazdevs%2Fgatsby-plugin-reading-time-2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prazdevs%2Fgatsby-plugin-reading-time-2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prazdevs%2Fgatsby-plugin-reading-time-2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prazdevs%2Fgatsby-plugin-reading-time-2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prazdevs","download_url":"https://codeload.github.com/prazdevs/gatsby-plugin-reading-time-2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247852314,"owners_count":21006924,"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":[],"created_at":"2024-10-10T15:46:49.943Z","updated_at":"2025-04-08T13:34:24.610Z","avatar_url":"https://github.com/prazdevs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"175px\" alt=\"\" src=\"https://i.imgur.com/6k7mL9G.png\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eArtwork by \u003ca href=https://undraw.co/\"\u003eKaterina Limpitsouni\u003c/a\u003e\u003c/i\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003egatsby-plugin-reading-time-2\u003c/h1\u003e\n\u003cp align=\"center\"\u003eA Gatsby plugin to estimate your markdown files reading time.\u003c/p\u003e\n\n\u003e _This plugin is sort of a fork from [`gatsby-remark-reading-time`](https://github.com/syntra/gatsby-remark-reading-time) updated and with added configuration._ \n\n## ✨ Features\n\n- Medium like reading time estimation (based on [`reading-time`](https://github.com/ngryman/reading-time)).\n- Compatible with `Mdx` and `MarkdownRemark`.\n- Configurable.\n\n## ⚙️ Installing\n\nFor Yarn users:\n```sh\nyarn add gatsby-plugin-reading-time-2\n```\nFor Npm users:\n```sh\nnpm install gatsby-plugin-reading-time-2\n```\n\n## 🚀 Usage\n\n### With `Mdx`\n\nAdd `gatsby-plugin-reading-time-2` as a plugin in `gatsby-config.js`:\n```js\nmodule.exports ={\n  plugins: [\n    // ...\n    `gatsby-plugin-reading-time-2`,\n    // ...\n  ],\n}\n```\n\n### With `MarkdownRemark`\n\nAdd `gatsby-plugin-reading-time-2` as a `MarkdownRemark` plugin in `gatsby-config.js`:\n```js\nmodule.exports ={\n  plugins: [\n    // ...\n    {\n      resolve: `gatsby-transformer-remark`,\n      options: {\n        plugins: [\n          // ...\n          `gatsby-plugin-reading-time-2`,\n          //... \n        ]\n      }\n    },\n    // ...\n  ],\n}\n```\n\n## 🔧 Configuration\n\nThis plugin accepts 2 options following [`reading-time`](https://github.com/ngryman/reading-time) options: \n- `options.wordsPerMinute`: the words per minute an average reader can read (default: 200).\n- `options.wordBound`: a function that returns a boolean value depending on if a character is considered as a word bound (default: spaces, new lines and tabs).\n\nResolve the plugin as follows to use them:\n\n```js\n{\n  resolve: `gatsby-plugin-reading-time-2`,\n  options: {\n    wordsPerMinute: 200,\n    wordBound: function(c) { return ' \\n\\r\\t'.includes(c) },\n  }\n}\n```\n\n## 🤝 Contributing\n\nAny contribution to the project is welome.  \nRun into a problem? Open an [issue](https://github.com/prazdevs/gatsby-plugin-reading-time-2/issues/new/choose).  \nWant to add some feature? PRs are welcome!\n\n## 📝 Licence\n\nCopyright © 2021 [Sacha Bouillez](https://github.com/prazdevs).\u003cbr /\u003e\nThis project is under [MIT](https://github.com/prazdevs/gatsby-plugin-reading-time/blob/main/LICENCE) license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprazdevs%2Fgatsby-plugin-reading-time-2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprazdevs%2Fgatsby-plugin-reading-time-2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprazdevs%2Fgatsby-plugin-reading-time-2/lists"}