Giter Club home page Giter Club logo

vscode-docs's Introduction

vscode logo

Visual Studio Code Documentation

You've found the Visual Studio Code documentation GitHub repository, which contains the content for the Visual Studio Code documentation.

Topics submitted here will be published to the Visual Studio Code portal.

If you are looking for the VS Code product GitHub repository, you can find it here.

Index

  1. About Visual Studio Code
  2. Feedback
  3. Documentation Issues
  4. Contributing to the documentation
  5. Publishing

Visual Studio Code

VS Code is a lightweight source code editor and powerful development environment for building and debugging modern web and cloud applications. It is free and available on your favorite platform - Linux, macOS, and Windows.

If you landed here looking for other information about VS Code, head over to our website for additional information.

Feedback

If you want to give documentation feedback, please use the feedback control located at the bottom of each documentation page.

Documentation Issues

To enter documentation bugs, please create a new GitHub issue. Please check if there is existing issue first.

If you think the issue is with the VS Code product itself, please enter issues in the VS Code product repo here.

Contributing

To contribute with new topics / information or make changes to existing documentation, please read the Contributing Guideline.

Workflow

The two suggested workflows are:

  • For small changes, use the "Edit" button on each page to edit the Markdown file directly on GitHub.
  • If you plan to make significant changes or preview the Markdown files in VS Code, clone the repo to edit and preview the files directly in VS Code.

Markdown Preview Button

Cloning

We have adopted Git LFS to store the images in this repo. Bare git clone will take 1.4GB+, and we recommend the following setup:

  • Install Git LFS.
  • git lfs install. You only need to run this once.
  • GIT_LFS_SKIP_SMUDGE=1 git clone [email protected]:Microsoft/vscode-docs.git. This only downloads text files that amount to ~16MB.
  • git lfs pull -I <PATTERN>, where <PATTERN> is a string of comma-separated globs. For example:
    • git lfs pull -I "docs/nodejs". Only download images in docs/nodejs.
    • git lfs pull -I "release-notes/images/1_3*/*". Only download images in latest release notes.
  • Alternatively, use git config lfs.fetchinclude "docs" so future git lfs pull only pulls images in docs.

The history of this repo before we adopt LFS can be found at microsoft/vscode-docs-archive.

Publishing

Steps for how to publish documentation changes can be found here in the (private) repository of the VS Code website.

vscode-docs's People

Contributors

octref avatar joaomoreno avatar jlvallelonga avatar auchenberg avatar

Stargazers

Tuan Vu avatar

Watchers

James Cloos avatar Tuan Vu 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.