{"id":15057026,"url":"https://github.com/ntt4/mkdocs-timetoread-plugin","last_synced_at":"2025-04-10T10:05:05.979Z","repository":{"id":58407375,"uuid":"531699483","full_name":"ntt4/mkdocs-timetoread-plugin","owner":"ntt4","description":"A lightweight 'estimated time to read' generator for MkDocs ","archived":false,"fork":false,"pushed_at":"2024-08-03T10:52:33.000Z","size":3,"stargazers_count":5,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T08:55:02.082Z","etag":null,"topics":["mkdocs","mkdocs-plugin","mkdocs-plugins"],"latest_commit_sha":null,"homepage":"","language":"Python","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/ntt4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2022-09-01T22:03:56.000Z","updated_at":"2025-02-13T02:53:43.000Z","dependencies_parsed_at":"2024-09-29T08:00:28.562Z","dependency_job_id":null,"html_url":"https://github.com/ntt4/mkdocs-timetoread-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntt4%2Fmkdocs-timetoread-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntt4%2Fmkdocs-timetoread-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntt4%2Fmkdocs-timetoread-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntt4%2Fmkdocs-timetoread-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ntt4","download_url":"https://codeload.github.com/ntt4/mkdocs-timetoread-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198879,"owners_count":21063628,"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":["mkdocs","mkdocs-plugin","mkdocs-plugins"],"created_at":"2024-09-24T22:01:07.199Z","updated_at":"2025-04-10T10:05:05.933Z","avatar_url":"https://github.com/ntt4.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-timetoread-plugin\n\nmkdocs-timetoread-plugin is a lightweight *'estimated time to read'* generator for MkDocs inspired by @alanhamlett's [readtime](https://github.com/alanhamlett/readtime) and Medium's [read time formula](https://help.medium.com/hc/en-us/articles/214991667-Read-time).\n\n## Setup\n\nInstall the plugin using pip:\n\n`pip install mkdocs-timetoread-plugin`\n\nActivate the plugin in `mkdocs.yml`:\n\n```yaml\nplugins:\n  - search\n  - timetoread\n```\n\n\u003e **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.\n## mkdocs.yml Configuration\n\n* `wpm` - Sets the 'words per minute' value for calculating estimated read time.\n  * Default value is `255`\n  * Possible value range: `1` - `999`\n\n* `allPages` - Sets all markdown files to have their read times' calculated unless explicitly disabled in the files' Front Matter.\n  * Default value is `True`\n  * Possible values: `True` or `False`\n\n* `textColor` - Sets the CSS color for styling the 'Estimated read time:' text.\n  * Default value is `bdbdbd`\n  * Possible value range: `000000` - `ffffff`\n\n### Example Configuration\n```yaml\nplugins:\n  - timetoread:\n      wpm: 190\n      allPages: True\n      textColour: 000000\n```\n\n## Front Matter\n\nOther configuration options are available by defining the following in a YAML front matter block in each markdown file.\n\n```yaml\n// Disable timetoread on a per file basis if `allPages is set to True\ntimetoread: False\n```\n\n```yaml\n// Enable timetoread on a per file basis if `allPages` is set to False\ntimetoread: True\n```\n## Usage\n\nOnce activated `mkdocs-timetoread-plugin` will automatically add a new line, with the estimated time to read the document, after the `\u003c/h1\u003e` tag in the HTML output generated by MkDocs.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntt4%2Fmkdocs-timetoread-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntt4%2Fmkdocs-timetoread-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntt4%2Fmkdocs-timetoread-plugin/lists"}