Repository files navigation

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

Topics submitted here will be published to theVisual Studio Code portal.

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

Note: The vscode-docs repository usesGit LFS (Large File Storage) for storing binary files such as images and.gifs. If you are contributing or updating images, please enable Git LFS per the instructions in theContributing section below.

• Index
• Visual Studio Code
• Feedback
• Documentation Issues
• Contributing
  • Workflow
  • Cloning
    • Cloning without binary files
• Publishing

VS Code is a lightweight source code editor and powerful development environment for building and debugging modern web, mobile, 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 toour website for additional information.

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

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

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

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

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 toedit and preview the files directly in VS Code.

1. InstallGit LFS.
2. Rungit lfs install to setup global git hooks. You only need to run this once per machine.
3. SSH auth:git clone git@github.com:microsoft/vscode-docs.git
   HTTPS auth:git clone https://github.com/microsoft/vscode-docs.git
4. Now you cangit add binary files and commit them. They'll be tracked in LFS.

You might want to clone the repo without the 1.6GB images. Here are the steps:

1. InstallGit LFS.
2. Rungit lfs install to setup global git hooks. You only need to run this once per machine.
3. Clone the repo without binary files.
   • macOS / Linux:
     • SSH auth:GIT_LFS_SKIP_SMUDGE=1 git clone git@github.com:microsoft/vscode-docs.git
     • HTTPS auth:GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/microsoft/vscode-docs.git
   • Windows:
     • SSH auth:$env:GIT_LFS_SKIP_SMUDGE="1"; git clone git@github.com:microsoft/vscode-docs.git
     • HTTPS auth:$env:GIT_LFS_SKIP_SMUDGE="1"; git clone https://github.com/microsoft/vscode-docs.git
4. Now you can selectively checkout some binary files to work with. For example:
   • git lfs pull -I "docs/nodejs" to only download images indocs/nodejs
   • git lfs pull -I "release-notes/images/1_4*/*" to only download images inrelease-notes/images/1_4*
   • git lfs pull -I "docs,api" to download all images indocs and inapi
   • git lfs pull -I <PATTERN>, as long as<PATTERN> is a validGit LFS Include and Exclude pattern.

The history of this repo before we adopted LFS can be found atmicrosoft/vscode-docs-archive.

Publishing merged pull requests is not automatic and is initiated manually after changes have been reviewed on an internal staging server. There is no specific time guarantee for when PR updates will be available onhttps://code.visualstudio.com but the intent is that they will usually be live within 24 hours.