Show README
This Visual Studio Code extension displays the content of a package's README file when you hover over the package name.
Features
- Displays the content of a package's README file in a popup when you hover over the package name in an import statement.
Installation
- Install the extension from the Visual Studio Code Marketplace.
- Open a project containing JavaScript or TypeScript files.
- Hover over the name of a package in an import statement to display the content of the README file.
Usage
- Open a JavaScript or TypeScript file in Visual Studio Code.
- Hover over the name of a package in an import statement, for example:
import axios from 'axios';
- A popup will appear with the content of the package's README file.
Dependencies
- axios: Used to make HTTP requests to fetch the README content from the npm registry.
- marked: Used to convert the Markdown content of the README to HTML.
Contributing
Contributions are welcome! If you would like to contribute to this extension, please follow these steps:
- Fork this repository.
- Create a branch for your feature (git checkout -b feature/my-feature).
- Commit your changes (git commit -am 'Add my feature').
- Push your branch (git push origin feature/my-feature).
- Open a Pull Request.
License
This extension is licensed under the MIT License. See the LICENSE file for more details.
| |