Giter Site home page Giter Site logo

alyadusov / vscode-docs-view Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mattbierner/vscode-docs-view

0.0 0.0 0.0 1.97 MB

VS Code extension that displays hover documentation in the sidebar or panel

Home Page: https://marketplace.visualstudio.com/items?itemName=bierner.docs-view

JavaScript 14.46% CSS 2.68% TypeScript 82.86%

vscode-docs-view's Introduction

Docs View

VS Code extension that displays hover documentation in the sidebar or panel.

The docs view in the sidebar

The docs view in the panel

Features

  • Automatically displays documentation for the symbol at the current cursor position.
  • Language independent. Works in any language that supports hovers.
  • The "Documentation" view shows in the panel by default. Move to other views or the panel just by dragging.
  • Supports syntax highlighting and markdown rendering in the docs view.

Configuration

  • docsView.documentationView.updateMode — Controls how the documentation view is updated when the cursor moves. Possible values:

    • live — (default) The documentation always tracks the current cursor position.
    • sticky — The documentation tracks the current cursor position. However if there is no content at the current position, it continues showing the previous documentation.

Commands

  • Pin current docs — Stop live updating of the docs view. Keeps the currently visible docs.
  • Unpin current docs — Make the docs view start tracking the cursor again.

vscode-docs-view's People

Contributors

mattbierner avatar serras avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.