# Novel Hide in Code
**Novel Hide in Code** is a VS Code extension that allows you to read novels within the code editor. It supports configuring the novel path, selecting a novel, displaying progress, and navigating pages.
## Features
- **Configure Novel Folder Path:** Set the path to the folder containing your novel TXT files.
- **Select Novel:** Choose a novel from the configured folder to read within VS Code.
- **Display Novel Content:** Show the content of the selected novel in the editor.
- **Page Navigation:** Navigate through the novel with previous and next page commands.
- **Progress Display:** Show the reading progress as a percentage.
- **Customizable:** Adjust the maximum line length and the number of lines displayed per page.
## Commands
| Command | Description |
| --- | --- |
| `extension.showNovel` | Show the content of the selected novel. |
| `extension.previousPage` | Navigate to the previous page of the novel. |
| `extension.nextPage` | Navigate to the next page of the novel. |
| `extension.setNovelFolderPath` | Set the path to the folder containing your novel TXT files. |
| `extension.showCodeLensAtCursor` | Show CodeLens at the cursor position. |
| `extension.toggleCodeLens` | Toggle the display of CodeLens. |
| `extension.updateConfig` | Update the maximum line length and the number of lines displayed per page. |
## Keybindings
| Keybinding | Command |
| --- | --- |
| `PageUp` | `extension.previousPage` |
| `PageDown` | `extension.nextPage` |
## Configuration
The extension provides the following configuration options:
- `novelHideInCode.novelFolderPath`: The path to the folder containing novel TXT files. Default is an empty string.
- `novelHideInCode.maxLineLength`: The maximum number of characters per line. Default is 50.
- `novelHideInCode.numberOfLines`: The number of lines to display, including the last line from the previous page. Default is 5.
## Usage
1. **Set Novel Folder Path:** Use the command `extension.setNovelFolderPath` to set the path to the folder containing your novel TXT files.
2. **Select and Show Novel:** Use the command `extension.showNovel` to select a novel and display its content in the editor.
3. **Navigate Pages:** Use the keybindings `PageUp` and `PageDown` to navigate through the novel.
4. **Update Configuration:** Use the command `extension.updateConfig` to update the maximum line length and the number of lines displayed per page.
## Development
To run and develop the extension:
1. Clone the repository.
2. Install the dependencies using `npm install`.
3. Open the project in VS Code.
4. Run the extension using the Run and Debug panel.
## Contributing
Contributions are welcome! Please submit issues and pull requests on the [Gitee repository](https://gitee.com/notomatoes/hide-novel-in-code).
## License
This project is licensed under the MIT License.
马建仓 AI 助手
