Skip to content

Commit 0301e4b

Browse files
committed
consolidated images
1 parent 2d66468 commit 0301e4b

23 files changed

+140
-255
lines changed

.github/workflows/issuesync.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
github_token: "${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}"
1616
ado_organization: "ceapex"
1717
ado_project: "Engineering"
18-
ado_area_path: "Engineering\\Teams\\AXE"
18+
ado_area_path: "Engineering\\Authoring"
1919
ado_wit: "User Story"
2020
ado_new_state: "New"
2121
ado_close_state: "Closed"

.gitignore

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,2 @@
1-
2-
*.vsix
3-
docs-metadata/install.Lock
4-
5-
.vscode/*
61
node_modules
7-
8-
**/.DS_Store
2+
.vsix

.gitmodules

Lines changed: 0 additions & 3 deletions
This file was deleted.

packages/docs-authoring-pack/.vscodeignore renamed to .vscodeignore

File renamed without changes.
File renamed without changes.

LICENSE

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
MIT License
1+
MIT License
22

3-
Copyright (c) 2018 - present Microsoft Corporation
3+
Copyright (c) Microsoft Corporation. All rights reserved.
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
1111

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1414

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE

README.md

Lines changed: 90 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This repo contains the Learn Authoring Pack VS Code extension, which is an extension pack containing multiple Markdown and YAML helper extensions. The main goal is to provide authoring assistance for contributing to learn.microsoft.com. This repo is our feedback mechanism allowing the community to report issues. We are not accepting outside contributions, but would like to continue improving the existing extensions supported in the Learn Authoring Pack.
44

5-
## Docs Authoring Pack
5+
## Learn Authoring Pack
66

7-
The Docs Authoring Pack provides a series of extensions to help docs.microsoft.com authors work better and more efficiently. You can read more about all of the Docs Authoring Pack features here in the [overview guide](https://docs.microsoft.com/contribute/how-to-write-docs-auth-pack). The Docs Authoring Pack provides the following extensions to help author content for docs.microsoft.com:
7+
The Learn Authoring Pack provides a series of extensions to help learn.microsoft.com authors work better and more efficiently. You can read more about all of the Learn Authoring Pack features here in the [overview guide](https://learn.microsoft.com/contribute/how-to-write-docs-auth-pack). The Learn Authoring Pack provides the following extensions to help author content for learn.microsoft.com:
88

99
- [Learn Markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown), which provides Markdown authoring assistance, including support for inserting custom Markdown syntax specific to learn.microsoft.com. The rest of this readme provides details on the Learn Markdown extension.
1010
- [Learn Images](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-images), which compresses and resizes images.
@@ -13,4 +13,91 @@ The Docs Authoring Pack provides a series of extensions to help docs.microsoft.c
1313
- [Learn Article Templates](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-article-templates), which allows users to apply Markdown skeleton content to new files.
1414
- [Learn Scaffolding](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-scaffolding), which automatically generates Learn modules based on standard patterns and automates renaming, inserting, deleting, and reordering units.
1515
- [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint), a popular linter by David Anson.
16-
16+
17+
## How to use the Learn Markdown extension
18+
19+
To access the Learn Markdown Authoring menu, type <kbd>ALT + M</kbd>. You can click or use up/down arrows to select the function you want, or type to start filtering, then hit <kbd>ENTER</kbd> when the function you want is highlighted in the menu.
20+
21+
![Learn markdown quick pick](https://raw.githubusercontent.com/microsoft/vscode-docs-authoring/main/media/image/docs-markdown-quick-pick.png)
22+
23+
You can also access the Learn commands from the VS Code command palette by hitting <kbd>F1</kbd> and typing to filter. All the Learn commands begin with "Learn".
24+
25+
### Prerequisites and assumptions
26+
27+
To accurately insert relative links, images, and other embedded content with Learn Markdown, you must have your VS Code workspace scoped to the root of your cloned OPS repo. Some syntax supported by the extension, such as alerts and snippets, are custom Markdown for Docs, and will not render correctly unless published via Learn.
28+
29+
For more information about the Learn Markdown commands, see the [Learn Markdown readme](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown).
30+
31+
## How to use Learn Images extension
32+
33+
To access the Learn Images menu, right click on a folder or individual image file. Select **Compress all images in folder** or **Compress image** from the context menu.
34+
35+
![Learn image context menu](https://raw.githubusercontent.com/microsoft/vscode-docs-authoring/main/media/image/right-click-image-compression.png)
36+
37+
For more information about the Learn Images extension, see the [Learn Images readme](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-images).
38+
39+
## How to use Learn YAML extension
40+
41+
- The code intellisense is more intelligent now; the extension can provide the intellisense according to the schema structure, not just text mapping. To invoke intellisense, hit <kbd>CTRL + Space</kbd> to view the list of schema options.
42+
- The extension can generate an input template for `object` (including required properties and optional properties with default value).
43+
- You can type a `-` and hit <kbd>CTRL + Space</kbd> to trigger the intellisense for generating a new array item.
44+
45+
Intellisense is automatically triggered by <kbd>CTRL + Space</kbd> to get what you can type.
46+
47+
![screencast](https://raw.githubusercontent.com/vscode-docs-authoring/main/media/image/docs-yaml-extension-intellisense.gif)
48+
49+
For more information about the Learn YAML commands, see the [Learn YAML readme](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-yaml).
50+
51+
## How to use Learn Preview extension
52+
53+
You can open Learn Preview by opening a markdown document and clicking on the preview button. One opens the preview in your current window, and the other opens the markdown preview to the side. Alternatively you can hit <kbd>Alt + M</kbd> and select `Preview` or you can hit <kbd>F1</kbd> and select `Docs: Preview` to open up the markdown preview panel.
54+
55+
![Learn preview buttons](https://raw.githubusercontent.com/microsoft/vscode-docs-authoring/main/media/image/docs-preview-button.png)
56+
57+
For more information about the Learn Preview commands, see the [Learn Preview readme](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-preview).
58+
59+
## Learn Markdown keyboard shortcuts and toolbar
60+
61+
### How to assign keyboard shortcuts
62+
63+
Default keyboard shortcuts are available for some commands, as noted in the table above. You can override them, or add shortcuts for other commands, using the VS Code keyboard shortcut mappings.
64+
65+
1. Type <kbd>CTRL+K</kbd> then <kbd>CTRL+S</kbd> to open the Keyboard Shortcuts list.
66+
1. Search for the command, such as `formatBold`, for which you want to create a custom keybinding.
67+
1. Click the plus that appears near the command name when you mouse over the line.
68+
1. After a new input box is visible, type the keyboard shortcut you want to bind to that particular command. For example, to use the common shortcut for bold, type <kbd>CTRL+B</kbd>.
69+
1. It's a good idea to insert a `when` clause into your keybinding, so it won't be available in files other than Markdown. To do this, open keybindings.json and insert the following line below the command name (be sure to add a comma between lines):
70+
71+
`"when": "editorTextFocus && editorLangId == 'markdown'"`
72+
73+
Your completed custom keybinding should look like this in keybindings.json:
74+
75+
```json
76+
// Place your key bindings in this file to overwrite the defaults
77+
[
78+
{
79+
"key": "ctrl+b",
80+
"command": "formatBold",
81+
"when": "editorTextFocus && editorLangId == 'markdown'"
82+
}
83+
]
84+
```
85+
86+
1. Save keybindings.json.
87+
88+
See [Keybindings](https://code.visualstudio.com/docs/getstarted/keybindings) in the VS Code Learn for more information.
89+
90+
### How to show the Markdown toolbar
91+
92+
Users of the pre-release version of the extension will notice that the authoring toolbar no longer appears at the bottom of the VS Code window when the Learn Markdown extension is installed. This is because the toolbar took up a lot of space on the VS Code status bar, and did not follow best practices for extension UX, so it is deprecated in the new extension. However, you can optionally show the toolbar by updating your VS Code settings.json file as follows:
93+
94+
1. In VS Code, go to **File** > **Preferences** > **Settings** (<kbd>CTRL+,</kbd>).
95+
1. Select User Settings to change the settings for all VS Code workspaces, or Workspace Settings to change them for just the current workspace.
96+
1. In the **Default Settings** pane on the left, find Learn Markdown Extension Configuration, and select the pencil icon next to the desired setting, and select `true`. VS Code will automatically add the value to the settings.json file and you will be prompted to reload the window for the changes to take effect.
97+
1. Now you will see the toolbar at the bottom of your VS Code window:
98+
99+
![toolbar](https://raw.githubusercontent.com/Microsoft/vscode-docs-authoring/main/media/image/legacy-toolbar.png)
100+
101+
## License
102+
103+
[MIT](LICENSE)

cleanup-prepush.js

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/docs-authoring-pack/images/cleanup-script-context-menu.png renamed to media/image/cleanup-script-context-menu.png

File renamed without changes.

packages/docs-authoring-pack/images/docs-linting-problem.png renamed to media/image/docs-linting-problem.png

File renamed without changes.

0 commit comments

Comments
 (0)