GithubHelp home page GithubHelp logo

uzkjzjjz / vscode-docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from microsoft/vscode-docs

0.0 0.0 0.0 108.87 MB

Public documentation for Visual Studio Code

Home Page: http://code.visualstudio.com/docs

License: Other

Shell 14.04% JavaScript 24.84% CSS 57.95% Dockerfile 3.17%

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.

Note: The vscode-docs repository uses Git 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 the Contributing section below.

Index

Visual Studio Code

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 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 an 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 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

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

Cloning without binary files

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

  1. Install Git LFS.
  2. Run git 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 [email protected]: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 [email protected]: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 in docs/nodejs
    • git lfs pull -I "release-notes/images/1_4*/*" to only download images in release-notes/images/1_4*
    • git lfs pull -I "docs,api" to download all images in docs and in api
    • git lfs pull -I <PATTERN>, as long as <PATTERN> is a valid Git LFS Include and Exclude pattern.

The history of this repo before we adopted 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.

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 on https://code.visualstudio.com but the intent is that they will usually be live within 24 hours.

vscode-docs's People

Contributors

chuxel avatar ornelladotcom avatar mjbvz avatar tyriar avatar isidorn avatar aeschli avatar weinand avatar bpasero avatar ghogen avatar joaomoreno avatar sandy081 avatar dbaeumer avatar alexr00 avatar sbatten avatar octref avatar rjmolyneaux avatar meganrogge avatar jrieken avatar chrmarti avatar roblourens avatar bamurtaugh avatar rzhao271 avatar daviddossett avatar luabud avatar kraigb avatar connor4312 avatar egamma avatar tanhakabir avatar uchenkadicode avatar mohit-nain avatar

Stargazers

Roman 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.