sreader
Secret reader, a handy tool to quietly read local text files at the far right of the VS Code status bar.
Features
- Display the content of a local text file in the far right of the status bar
- Support for paging up and down
- Show/hide content
- Quit reading at any time
- Clear all reading progress
- Click "book" to setting configuration
Installation
- Available on VS Code Marketplace - search for "sreader".
- Or build from source and install via VSIX.
Usage
Tip: We recommend setting up keyboard shortcuts for the main commands for the most seamless reading experience!
- Configure the local text file path (
sreader.textPath) and page size (sreader.pageSize) in the settings.
- Use the vscode Command Palette and enter the following commands:
Show Secret: Display contentPage Up Secret: Navigate to previous pagePage Down Secret: Navigate to next pageHide Secret Content: Hide the content panelsQuit Secret Reader: Completely quit and clean upClear All Secret Offsets: Reset all reading progress
The content will be displayed as a single line at the far right of the status bar, perfect for discreet reading.
Configuration
| Setting |
Type |
Default |
Description |
| sreader.textPath |
string |
"" |
Path to the local text file |
| sreader.pageSize |
number |
40 |
Number of characters per page |
Commands
| Command |
Description |
| sreader.show |
Show content |
| sreader.pageUp |
Previous page |
| sreader.pageDown |
Next page |
| sreader.hide |
Hide content |
| sreader.quit |
Quit reading |
| sreader.clear |
Clear progress |
Examples
License
Apache-2.0
| |
