Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zivgit/vscode-doc-navigator
Provides navigation for various technical documents to facilitate developers to browse quickly.
https://github.com/zivgit/vscode-doc-navigator
dev-docs doc-explorer doc-navigator documentation visual-studio-code vscode vscode-extension
Last synced: 1 day ago
JSON representation
Provides navigation for various technical documents to facilitate developers to browse quickly.
- Host: GitHub
- URL: https://github.com/zivgit/vscode-doc-navigator
- Owner: ZivGit
- License: gpl-3.0
- Created: 2024-06-13T03:42:13.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-13T07:26:15.000Z (7 months ago)
- Last Synced: 2024-06-14T09:10:17.508Z (7 months ago)
- Topics: dev-docs, doc-explorer, doc-navigator, documentation, visual-studio-code, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# DocNavigator
[](https://marketplace.visualstudio.com/items?itemName=your-publisher-id.DocNavigator)
[](https://marketplace.visualstudio.com/items?itemName=your-publisher-id.DocNavigator)
DocNavigator is a Visual Studio Code extension designed to provide quick and easy access to various technical documentation. This tool aims to enhance developers' productivity by enabling seamless navigation through documentation directly within the VS Code environment.
## Features
- **Quick Access to Documentation**: Search and open documentation from a variety of sources quickly.
- **Customizable Sources**: Add your own favorite documentation sources for easy access.
- **Integrated Search**: Use the integrated search functionality to find specific topics within the documentation.
- **Bookmarks**: Save and manage bookmarks for frequently accessed documentation pages.
## Installation
1. Open Visual Studio Code.
2. Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing `Ctrl+Shift+X`.
3. Search for `DocNavigator`.
4. Click the `Install` button.
Alternatively, you can install DocNavigator from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=your-publisher-id.DocNavigator).
## Usage
1. Open the Command Palette by pressing `Ctrl+Shift+P`.
2. Type `DocNavigator: Open Documentation` and select it from the list.
3. Enter the name of the documentation you want to access.
4. Use the integrated search feature to find specific topics or pages within the documentation.
### Customizing Documentation Sources
To add or customize documentation sources:
1. Open the Command Palette (`Ctrl+Shift+P`).
2. Type `DocNavigator: Manage Sources` and select it.
3. Follow the prompts to add, remove, or update documentation sources.
### Bookmarking Pages
To bookmark a documentation page:
1. Open the documentation page in the DocNavigator view.
2. Click on the bookmark icon to save the page for quick access later.
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please create an issue on the [GitHub repository](https://github.com/your-username/DocNavigator).
### Developing
1. Fork the repository on GitHub.
2. Clone your fork locally:
```bash
git clone https://github.com/your-username/DocNavigator.git
```
3. Open the repository in Visual Studio Code:
```bash
code DocNavigator
```
4. Install the dependencies:
```bash
npm install
```
5. Start the extension in development mode by pressing `F5`.
### Pull Requests
1. Create a new branch for your feature or bug fix:
```bash
git checkout -b feature/your-feature-name
```
2. Make your changes and commit them:
```bash
git commit -m "Description of your changes"
```
3. Push your branch to GitHub:
```bash
git push origin feature/your-feature-name
```
4. Create a pull request on the original repository.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgements
- Thanks to the VS Code team for creating such a powerful and extensible editor.
- Special thanks to all contributors who helped make this project better.
---
If you have any questions or need further assistance, please feel free to reach out on the [GitHub issues page](https://github.com/your-username/DocNavigator/issues).