MIT License
A Visual Studio Code extension ideal for writers who want an estimate for how long it may take to read your articles.
View β Extensions
Read Time
Commands can be found in the command palette. Look for commands beginning with Read Time:
Features include:
Property | Description |
---|---|
readTime.enabled | Specifies whether it is enabled |
readTime.fileTypes | Specifies the file types to estimate the time to read. |
readTime.wordsPerMinute | Specifies the estimated words per minute that a user may read. |
Defaults to ["markdown"]
, but can be an array of any file types (languageId) that you want to estimate read time.
"readTime.fileTypes": [
"markdown",
"plaintext",
"yaml"
]
Defaults to 200
, but can be any number representing the number of words per minute you wish to use in the calculation.
"readTime.wordsPerMinute": 200
Command | Description |
---|---|
Read Time: Toggle Enable/Disable | Enables or disables read time |
There is only so much room in the status bar and the Read Time status bar icon may have become a casualty and disappeared. You can test this by zooming out of your vs code a few times so the text is very small. This will also zoom out the status bar. If the status bar icon was a casualty, then it would reappear when you zoom out.
The Read Time icon is very slim (just an icon and a number). However if it is not appearing you can try to change your settings for other items in the status bar to make them disappear. In other word, clean up your status bar by hiding things you do not want to see. Here is one example where I hid a few things that were in my status bar.
"workbench.statusBar.feedback.visible": false,
"debug.showInStatusBar": "never",
"azure.showSignedInEmail": false,
"liveshare.showInStatusBar": "whileCollaborating",
"spellright.statusBarIndicator": false
There are many features in the roadmap. Please refer to the issues list and feel free to grab one and contribute!
See the CHANGELOG for the latest changes.
Inspiration comes in many forms. These folks and teams have contributed either through ideas, issues, pull requests, or guidance. Thank you!
The VS Code team and their incredibly helpful guide for creating extensions
Here are some great examples for extensions from the VS Code team
If you want to try the extension out start by cloning this repo, cd
into the folder, and then run npm install
.
Then you can run the debugger for the launch configuration Run Extension
. Set breakpoints, step through the code, and enjoy!