|
| 1 | +# Visual Studio Code Documentation |
| 2 | + |
| 3 | +You've found the GitHub repository that houses the source for the VS Code docs at <https://code.visualstudio.com/docs>. |
| 4 | + |
| 5 | +## Contribute to VS Code documentation |
| 6 | + |
| 7 | +Thank you for your interest in VS Code documentation! |
| 8 | + |
| 9 | +* [Contributing](#contributing) |
| 10 | +* [Documentation intent](#documentation-intent) |
| 11 | +* [Repository organization](#repository-organization) |
| 12 | +* [Branches](#branches) |
| 13 | +* [Authoring Tools](#authoring-tools) |
| 14 | +* [How to use Markdown to format your topic](#how-to-use-markdown-to-format-your-topic) |
| 15 | +* [Topic Metadata](#topic-metadata) |
| 16 | +* [Formatting](#formatting) |
| 17 | + |
| 18 | +>**Note**: Before submitting a pull request, especially for rendering or link issues, please review the content on the official VS Code website, [code.visualstudio.com](https://code.visualstudio.com). The element in question may render correctly after processing by the website build. |
| 19 | +
|
| 20 | +## Contributing |
| 21 | + |
| 22 | +To contribute to [VS Code documentation](https://code.visualstudio.com/docs), you need to fork this repository and submit a pull request for the Markdown and/or image changes that you're proposing. |
| 23 | + |
| 24 | +* [How to fork a repository](https://help.github.com/articles/fork-a-repo) |
| 25 | +* [How to make a pull request](https://help.github.com/articles/creating-a-pull-request/) |
| 26 | +* [Changing a commit message](https://help.github.com/articles/changing-a-commit-message/) |
| 27 | +* [How to squash commits](https://help.github.com/articles/about-pull-request-merges/) |
| 28 | + |
| 29 | +## Documentation intent |
| 30 | + |
| 31 | +The goal of the VS Code documentation is to educate users on VS Code features and how VS Code can be used to enhance their development experience with different programming languages and runtimes. |
| 32 | + |
| 33 | +The documentation is not intended to provide: |
| 34 | + |
| 35 | +* An introduction to coding or software development |
| 36 | +* Tutorials on technologies independent from VS Code |
| 37 | +* Promotion of third-party tools, plug-ins or services |
| 38 | +* Excessive detail or advanced walkthroughs |
| 39 | + |
| 40 | +The documentation should target developers learning to use VS Code or searching for quick answers to commonly asked questions. Other forums such as blog posts can provide more detailed content elaborating on specific scenarios. |
| 41 | + |
| 42 | +## Repository organization |
| 43 | + |
| 44 | +The content in this repository follows the organization of documentation at <https://code.visualstudio.com/docs>. |
| 45 | + |
| 46 | +This repository contains the following folders: |
| 47 | + |
| 48 | +* \setup |
| 49 | +* \introvideos |
| 50 | +* \getstarted |
| 51 | +* \editor |
| 52 | +* \languages |
| 53 | +* \extensions |
| 54 | +* \extensionAPI |
| 55 | +* \other |
| 56 | +* \supporting |
| 57 | + |
| 58 | +Within these folders you'll find the Markdown files used for the content. Each of these folders also contains an \images folder that references the images (such as screenshots) used in the topics. |
| 59 | + |
| 60 | +### Branches |
| 61 | + |
| 62 | +We recommend that you create local working branches that target a specific scope of change (and then submit a pull request when your changes are ready). Each branch should be limited to a single concept/topic, both to streamline work flow, and to reduce the possibility of merge conflicts. The following efforts are of the appropriate scope for a new branch: |
| 63 | + |
| 64 | +* A new topic (and associated images). |
| 65 | +* Spelling and grammar edits on a topic. |
| 66 | +* Applying a single formatting change across a large set of topics. |
| 67 | + |
| 68 | +## Authoring tools |
| 69 | + |
| 70 | +[Visual Studio Code](https://code.visualstudio.com) is a great editor for Markdown! |
| 71 | + |
| 72 | +In fact, VS Code and its core documentation are written using VS Code. |
| 73 | + |
| 74 | +## How to use Markdown to format your topic |
| 75 | + |
| 76 | +The topics in this repository use Markdown. Here is a good overview of [Markdown basics](https://help.github.com/articles/markdown-basics/). |
| 77 | + |
| 78 | +## Topic Metadata |
| 79 | + |
| 80 | +Topic metadata enables certain functionalities for the topics such as table of contents order, topic descriptions, and online search optimization as well as aiding Microsoft in evaluating the effectiveness of the content. |
| 81 | + |
| 82 | +* **Order** - This is the order that is used in the left rail TOC, the page is left out of the TOC if this is blank |
| 83 | +* **Area** - General area within VS Code |
| 84 | +* **TOCTitle** - The title used in the left rail Table of Contents for this page |
| 85 | +* **PageTitle** - The title used in the HTML title for the page and in search results |
| 86 | +* **ContentId** - A GUID which uniquely identifies the topic to DevDiv doc reporting. |
| 87 | +* **DateApproved** - This is set when the page is actually published on the VS Code portal. You can ignore it. |
| 88 | +* **MetaDescription** - The meta description for this page which helps for search. Use sentence structure limited to 300 characters. |
| 89 | +* **MetaSocialImage** - Optional. Used for og:image in page header for sharing on social media. Should be 1024 x 512 .png. |
| 90 | +* **MetaTags** - Optional. Further tags for this page again for search. |
| 91 | + |
| 92 | +## Product name |
| 93 | + |
| 94 | +Use the full product name "Visual Studio Code" in the topic MetaDescription and the first use in a topic. You can use the shortened "VS Code" after that throughout the rest of the content. Do not use "VSCode" (no space) or "Code". |
| 95 | + |
| 96 | +### Metadata for /api docs |
| 97 | + |
| 98 | +**For Writer**: |
| 99 | + |
| 100 | +* **MetaDescription** - The meta description for this page which helps for search |
| 101 | + |
| 102 | +**For Doc Maintainer**: |
| 103 | + |
| 104 | +* **DateApproved** - This is set when the page is actually published on the VS Code portal. |
| 105 | + |
| 106 | +## Formatting |
| 107 | + |
| 108 | +### Headings & Right Nav |
| 109 | + |
| 110 | +H2 subheadings `##` end up in the right hand jump list for the document (this happens in our compile script). It's a good idea to include h2 subheadings to help users get an overview of the doc and quickly navigate to the major topics. |
| 111 | + |
| 112 | +### Text formatting |
| 113 | + |
| 114 | +Use bold for VS Code commands and UI elements. |
| 115 | + |
| 116 | + **Extensions: Install Extension** |
| 117 | + **Debug Console** |
| 118 | + |
| 119 | +Limit the use of bold for emphasis unless it is crucial to get the user's attention. Avoid the use of italics for emphasis since italics doesn't render well on the code.visualstudio.com site. |
| 120 | + |
| 121 | +Use inline code formatting (backticks) for settings, filename and JSON attributes. |
| 122 | + |
| 123 | + `files.exclude` |
| 124 | + `tasks.json` |
| 125 | + `preLaunchTask` |
| 126 | + |
| 127 | +Use '>' to show menu sequence. |
| 128 | + |
| 129 | + **File** > **Preferences** > **Settings** |
| 130 | + **View** > **Command Palette** |
| 131 | + |
| 132 | +### Links |
| 133 | + |
| 134 | +For links within our own documentation, use a site relative link like `/docs/editor/codebasics.md`. |
| 135 | + |
| 136 | +>For example: `[Why VS Code](/docs/editor/whyvscode.md)` - links to the **Why Visual Studio Code** page |
| 137 | +
|
| 138 | +>**Correction:** For this repo to ease content development you should add the .md suffix. We will parse these out for the website deployment. |
| 139 | +
|
| 140 | +### Bookmarks |
| 141 | + |
| 142 | +To provide links to h2 subheadings (Markdown ##), the format is `[Link Text](page.md#subheading-title)`. |
| 143 | + |
| 144 | +Note the subheading title is lowercase and subheading title words are separated by '-' hyphens. |
| 145 | + |
| 146 | +>For example: `[Keyboard Shortcuts](/docs/editor/codebasics.md#keyboard-shortcuts)` - links to https://code.visualstudio.com/docs/editor/codebasics#_keyboard-shortcuts. |
| 147 | +
|
| 148 | +### Images |
| 149 | + |
| 150 | +Images are important to bring the product to life - even if people can't try the product, these really help them to see what they are missing. |
| 151 | + |
| 152 | +For images you're adding to the repo, store them in the `images` subfolder of the TOC section, for example: `editor\images\debugging`. |
| 153 | + |
| 154 | +When you link to an image, the path and filename are case-sensitive. The convention is for image filenames to be all lowercase. |
| 155 | + |
| 156 | +>For example: `` |
| 157 | +
|
| 158 | +### Key bindings |
| 159 | + |
| 160 | +The VS Code portal is able to show the correct key bindings depending on the reader's operating system (macOS, Windows or Linux). |
| 161 | + |
| 162 | +To enable this for keyboard shortcuts, use the format `kb(workbench.action.files.openFile)` where the command name is included in parentheses. |
| 163 | + |
| 164 | +>For a list of key bindings and the relevant `Command Ids` review the [key bindings document](https://code.visualstudio.com/docs/getstarted/keybindings). |
| 165 | +
|
| 166 | +If you are listing out multiple key bindings, you can use a table. |
| 167 | + |
| 168 | +>Shortcut|Key Strokes |
| 169 | +>--------|----------- |
| 170 | +>Cut|`kb(editor.action.clipboardCutAction)` |
| 171 | +>Copy|`kb(editor.action.clipboardCopyAction)` |
| 172 | +>Paste|`kb(editor.action.clipboardPasteAction)` |
| 173 | +
|
| 174 | +### Source Code |
| 175 | + |
| 176 | +For source code we use the fenced code block notation ```` ``` ````. |
| 177 | + |
| 178 | +>**Note:** You can add an optional language identifier to enable syntax highlighting in your fenced code block. E.g. ```` ```json ```` or ```` ```javascript ````. [Read more →](https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting) |
| 179 | +
|
| 180 | +Some JavaScript code... |
| 181 | + |
| 182 | +```javascript |
| 183 | +function fancyAlert(arg) { |
| 184 | + if (arg) { |
| 185 | + $.facebox({ div: foo }); |
| 186 | + } |
| 187 | +} |
| 188 | +``` |
0 commit comments