Links to useful resources : Appendix D
This guide provides links to resources that are useful for developing content in markdown.
Visual Studio Code (VSC)
-
Introduction to VSC. For VSC help, documentation, videos, “tips and tricks” guides, and additional resources, refer to https://code.visualstudio.com/docs/getstarted/introvideos.
-
VSC on Linux and MacOS. For information and guides specific to installing VSC on different operating systems, refer to Setting up Visual Studio Code.
-
VSC with Git. For detailed instructions on setting up VSC and Git, refer to Use Git with Visual Studio Code.
-
VSC shortcut keys. For information about VSC shortcut keys, refer to Key Bindings for Visual Studio Code.
-
Microsoft Docs Authoring Pack. For information about the Microsoft Docs Authoring Pack, refer to Announcing the Docs Markdown Extension for Visual Studio Code and the Visual Studio Marketplace webpage Docs Authoring Pack.
-
Docs linting extension. For information about the Docs linting extension for VSC, refer to Docs linting.
-
Markdown lint extension. For information about the Markdown lint extension for VSC, refer to Markdown lint.
-
Code spell checker extension. For information about the Code spell checker extension for VSC, refer to Code spell checker.
-
Word Count extension. For information about the Word Count extension for VSC, refer to WordCount.
-
GitHub pull requests extension. For information about the GitHub pull requests extension, refer to GitHub Pull Requests and Issues.
-
Azure repos extension. For information about the Azure repos extension for VSC, refer to Azure Repos.
Git
-
Git and version control. For information about version control and Git, refer to What is version control?
-
Git and GitHub fundamentals. For information about the fundamentals of Git and GitHub, refer to Git and GitHub essentials for Docs.
-
Set up and configure Git. For information about configuring Git, refer to 8.1 Customizing Git - Git Configuration.
-
Git with VSC. For a step-by-step guide to using Git with VSC, refer to Use Git with Visual Studio Code.
-
Create, clone, and archive repos. For information about creating, cloning, and archiving repositories, refer to the GitHub documentation webpage Creating, cloning, and archiving repositories.
-
Using branches. For information about using branches, refer to About branches.
-
Move or rename branch. For information about the Git move (rename) branch command, and other Git commands, refer to the Software Freedom Conservancy webpage Git branch.
-
Delete branch. For information about the Git
delete branch
command, refer to the Software Freedom Conservancy’s Git branch documentation. -
Save, stage, and commit file changes. For information about saving, staging, and committing file changes, refer to the Atlassian/ BitBucket webpage Saving changes.
-
Git cheat-sheets. For a concise guide to useful Git commands and features, refer to Git Cheatsheets.
-
Glossary. For a comprehensive glossary of Git-related terminology, refer to GitHub glossary.
GitHub
-
Create a GitHub account. If you don’t have a GitHub account, create one using the GitHub account setup guide.
-
GitHub help. For help with using GitHub , refer to GitHub online help.
-
GitHub pull requests (PRs). For information about GitHub PRs, refer to About Pull requests.
-
Resolve merge conflicts on GitHub. For information about resolving merge conflicts on GitHub, refer to About merge conflicts.
-
Resolve merge conflicts on the command line. To resolve a merge conflict using the command line, refer to the GitHub documentation webpage Resolving a merge conflict using the command line.
-
GitHub guides. For additional guides to using GitHub, refer to GitHub Guides.
Azure DevOps
-
Create an AzDevOps account. To create an AzDevOps account, refer to Sign up, sign in to Azure DevOps.
-
Azure DevOps documentation. For more information about Azure DevOps, refer to the Azure DevOps documentation
Markdown
-
Microsoft markdown syntax reference. For a reference guide to Microsoft’s markdown syntax, refer to Docs Markdown reference.
-
GitHub markdown syntax guide. For GitHub’s guide to the markdown syntax, refer to Basic writing and formatting syntax.
-
Code blocks. For a list of supported languages for code blocks, and how to specify them in markdown, refer to GitHub linguist languages.yml, and the webpage Creating and highlighting code blocks.
Contributing to Microsoft Docs
For information about contributing to Microsoft Docs, refer to the following resources (v- or Microsoft user account required).
-
Microsoft Learn contributors’ guide. The Microsoft Learn contributors’ guide provides information about developing content for Microsoft Learn.
-
Microsoft Docs contributors’ guide. The Microsoft Docs contributors’ guide provides information about developing content for Microsoft Docs. Microsoft Learn runs on the Microsoft Docs platform, and contributors to Microsoft Learn should find the Microsoft Docs contributors’ guide useful.
-
Microsoft style guide. The Microsoft style guide is a useful reference for terminology.
-
Microsoft Learn instructional design web page. The Microsoft Learn instructional design web page provides information about Microsoft’s instructional design practices.
Pandoc
- Pandoc documentation. For information about using Pandoc, refer to the Pandoc documentation website Getting started with pandoc.