Skip to content

Commit 9c4c5cc

Browse files
committed
Fixup markdown refereces to NPM packages
- NPM packages should be bold, not use inline code formatting - need to escape the `@` for package references - fixes SharePoint#5921
1 parent 3989692 commit 9c4c5cc

7 files changed

+24
-24
lines changed

docs/spfx/extensions/get-started/build-a-hello-world-extension.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first SharePoint Framework Extension (Hello World part 1)
33
description: Create an extension project, and then code and debug your Application Customizer.
4-
ms.date: 06/19/2020
4+
ms.date: 06/22/2020
55
ms.prod: sharepoint
66
localization_priority: Priority
77
ms.custom: scenarios:getting-started
@@ -69,7 +69,7 @@ You can also follow the steps in this article by watching the video on the Share
6969

7070
Open the **./src/extensions/helloWorld/HelloWorldApplicationCustomizer.ts** file.
7171

72-
Notice that base class for the Application Customizer is imported from the **@microsoft/sp-application-base** package, which contains SharePoint framework code required by the Application Customizer.
72+
Notice that base class for the Application Customizer is imported from the **\@microsoft/sp-application-base** package, which contains SharePoint framework code required by the Application Customizer.
7373

7474
The logic for your Application Customizer is contained in the `onInit()` method, which is called when the client-side extension is first activated on the page. This event occurs after `this.context` and `this.properties` are assigned. As with web parts, `onInit()` returns a promise that you can use to do asynchronous operations.
7575

docs/spfx/extensions/get-started/building-simple-cmdset-with-dialog-api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first ListView Command Set extension
33
description: Create an extension project, and then code and debug your extension by using SharePoint Framework (SPFx) Extensions.
4-
ms.date: 06/19/2020
4+
ms.date: 06/22/2020
55
ms.prod: sharepoint
66
ms.custom: scenarios:getting-started
77
---
@@ -57,17 +57,17 @@ You can follow these steps by watching the video on the SharePoint PnP YouTube C
5757
```json
5858
{
5959
"$schema": "https://developer.microsoft.com/json-schemas/spfx/command-set-extension-manifest.schema.json",
60-
60+
6161
"id": "95688e19-faea-4ef1-8394-489bed1de2b4",
6262
"alias": "HelloWorldCommandSet",
6363
"componentType": "Extension",
6464
"extensionType": "ListViewCommandSet",
65-
65+
6666
"version": "*",
6767
"manifestVersion": 2,
68-
68+
6969
"requiresCustomScript": false,
70-
70+
7171
"items": {
7272
"COMMAND_1": {
7373
"title": { "default": "Command One" },
@@ -82,7 +82,7 @@ You can follow these steps by watching the video on the SharePoint PnP YouTube C
8282
}
8383
}
8484
```
85-
85+
8686
Note the actual command definitions in the manifest file. These are the actual buttons that are exposed based on the registration target. In the default template, you find two different buttons: **Command One** and **Command Two**.
8787

8888
> [!NOTE]
@@ -92,7 +92,7 @@ You can follow these steps by watching the video on the SharePoint PnP YouTube C
9292

9393
Open the file **./src/extensions/helloWorld/HelloWorldCommandSet.ts**.
9494

95-
Notice the base class for the ListView Command Set is imported from the **@microsoft/sp-listview-extensibility** package, which contains SharePoint Framework (SPFx) code required by the ListView Command Set.
95+
Notice the base class for the ListView Command Set is imported from the **\@microsoft/sp-listview-extensibility** package, which contains SharePoint Framework (SPFx) code required by the ListView Command Set.
9696

9797
```typescript
9898
import { override } from '@microsoft/decorators';
@@ -319,7 +319,7 @@ Possible ___location values that can be used with a ListView Command Set:
319319

320320
### Ensure that definitions are taken into account within the build pipeline
321321

322-
Open the file **./config/package-solution.json**.
322+
Open the file **./config/package-solution.json**.
323323

324324
The **package-solution.json** file defines the package metadata as shown in the following code. To ensure that the **element.xml** file is taken into account while the solution package is created, the default scaffolding of this file is updated to include additional details for a feature definition. This feature definition is used to provision and execute the **elements.xml** file.
325325

docs/spfx/extensions/get-started/using-page-placeholder-with-extensions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Use page placeholders from Application Customizer (Hello World part 2)
33
description: Extend your Hello World extension to take advantage of page placeholders by using SharePoint Framework (SPFx) Extensions.
4-
ms.date: 06/19/2020
4+
ms.date: 06/22/2020
55
ms.prod: sharepoint
66
ms.custom: scenarios:getting-started
77
---
@@ -44,7 +44,7 @@ Notice that you're requesting a well-known placeholder by using the correspondin
4444

4545
### Modify the Application Customizer to access and modify placeholders by adding custom HTML elements
4646

47-
1. Install the **@microsoft/sp-office-ui-fabric-core** package to enable importing from **SPFabricCore.scss**. We'll use this for defining rendering styles for our place holders.
47+
1. Install the **\@microsoft/sp-office-ui-fabric-core** package to enable importing from **SPFabricCore.scss**. We'll use this for defining rendering styles for our place holders.
4848

4949
```console
5050
npm install @microsoft/sp-office-ui-fabric-core
@@ -88,7 +88,7 @@ Notice that you're requesting a well-known placeholder by using the correspondin
8888
```
8989

9090
1. In Visual Studio Code (or your preferred IDE), open **./src/extensions/helloWorld/HelloWorldApplicationCustomizer.ts.**
91-
1. Add the `PlaceholderContent` and `PlaceholderName` to the import statement from **@microsoft/sp-application-base** by updating the import statement as follows:
91+
1. Add the `PlaceholderContent` and `PlaceholderName` to the import statement from **\@microsoft/sp-application-base** by updating the import statement as follows:
9292

9393
```typescript
9494
import {

docs/spfx/office-addins-create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create Outlook add-ins using SharePoint Framework
33
description: Create Outlook Web App add-ins using SharePoint Framework
4-
ms.date: 06/18/2020
4+
ms.date: 06/22/2020
55
ms.prod: sharepoint
66
localization_priority: Normal
77
---
@@ -40,7 +40,7 @@ You'll need to deploy the solution to tenant using the **tenant scoped deploymen
4040
4141
## Use Office JavaScript SDK (Office.js) in the web part code
4242

43-
Before you can use the Office JavaScript SDK in your code, you'll need to include correct types for the solution. You can install latest types by adding **@types/office-js** package from the npm to your solution with following command:
43+
Before you can use the Office JavaScript SDK in your code, you'll need to include correct types for the solution. You can install latest types by adding **\@types/office-js** package from the npm to your solution with following command:
4444

4545
```console
4646
npm install @types/office-js --save-dev

docs/spfx/web-parts/basics/integrate-with-property-pane.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Make your SharePoint client-side web part configurable
33
description: Configure custom properties in your web part by using the property pane.
4-
ms.date: 06/16/2020
4+
ms.date: 06/22/2020
55
ms.prod: sharepoint
66
localization_priority: Priority
77
---
@@ -65,7 +65,7 @@ The following field types are supported:
6565
- Toggle
6666
- Custom
6767

68-
The field types are available as modules in **@microsoft/sp-property-pane**. You need to import the objects into a module before you can use them in your web parts:
68+
The field types are available as modules in **\@microsoft/sp-property-pane**. You need to import the objects into a module before you can use them in your web parts:
6969

7070
```typescript
7171
import {
@@ -80,7 +80,7 @@ import {
8080
```
8181

8282
> [!NOTE]
83-
> The property pane objects were split out into their own module, **@microsoft/sp-property-pane**, in the SharePoint Framework v1.9 release. Prior to this, they were included in the **@microsoft/sp-webpart-base** module.
83+
> The property pane objects were split out into their own module, **\@microsoft/sp-property-pane**, in the SharePoint Framework v1.9 release. Prior to this, they were included in the **\@microsoft/sp-webpart-base** module.
8484
8585
Every field type method is defined as follows, taking `PropertyPaneTextField` as an example:
8686

docs/spfx/web-parts/get-started/build-a-hello-world-web-part.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first SharePoint client-side web part (Hello World part 1)
33
description: Create a new web part project and preview it.
4-
ms.date: 06/15/2020
4+
ms.date: 06/22/2020
55
ms.prod: sharepoint
66
localization_priority: Priority
77
ms.custom: scenarios:getting-started
@@ -217,7 +217,7 @@ Notice that we're executing an HTML escape on the property's value to ensure a v
217217

218218
Let's now add a few more properties to the property pane: a checkbox, a drop-down list, and a toggle. We first start by importing the respective property pane fields from the framework.
219219

220-
1. Scroll to the top of the file and add the following to the import section from `@microsoft/sp-property-pane`:
220+
1. Scroll to the top of the file and add the following to the import section from **\@microsoft/sp-property-pane**:
221221

222222
```typescript
223223
PropertyPaneCheckbox,

docs/spfx/web-parts/get-started/use-fabric-react-components.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Use Office UI Fabric React components in your SharePoint client-side web part
33
description: Build a web part that uses the DocumentCard component of Office UI Fabric React.
4-
ms.date: 06/16/2020
4+
ms.date: 06/22/2020
55
ms.prod: sharepoint
66
localization_priority: Priority
77
ms.custom: scenarios:getting-started
@@ -28,7 +28,7 @@ The transition from Office UI Fabric to Fluent UI, and the respective React comp
2828

2929
SharePoint Framework (SPFx) packages currently reference the original Office UI Fabric NPM Packages. These packages are currently supported & will continue to work.
3030

31-
The primary Fluent UI React package, **@fluentui/react**, simply exports components from the **office-ui-fabric-react** package used in SharePoint Framework projects. At this time, you should continue to use the **office-ui-fabric-react** package in your SharePoint Framework projects.
31+
The primary Fluent UI React package, **\@fluentui/react**, simply exports components from the **office-ui-fabric-react** package used in SharePoint Framework projects. At this time, you should continue to use the **office-ui-fabric-react** package in your SharePoint Framework projects.
3232

3333
This page will continue to refer to the Office UI Fabric packages until Microsoft recommends switching to the Fluent UI packages. The documentation links on this page may point to the Fluent UI documentation but it applies to the Office UI Fabric as well.
3434

@@ -50,7 +50,7 @@ This page will continue to refer to the Office UI Fabric packages until Microsof
5050
cd documentcardexample-webpart
5151
```
5252

53-
1. Make sure you have the latest version of `@microsoft/generator-sharepoint` installed and create a new web part by running the Yeoman SharePoint generator:
53+
1. Make sure you have the latest version of **\@microsoft/generator-sharepoint** installed and create a new web part by running the Yeoman SharePoint generator:
5454

5555
```console
5656
yo @microsoft/sharepoint
@@ -70,7 +70,7 @@ This page will continue to refer to the Office UI Fabric packages until Microsof
7070

7171
At this point, Yeoman installs the required dependencies and scaffolds the solution files.
7272

73-
Starting with SPFx v1.8.2 version, Yeoman will include the recommended `@microsoft/sp-office-ui-fabric-core` package version to your solution when you select the **React** as the desired web framework.
73+
Starting with SPFx v1.8.2 version, Yeoman will include the recommended **\@microsoft/sp-office-ui-fabric-core** package version to your solution when you select the **React** as the desired web framework.
7474

7575
> [!NOTE]
7676
> Starting with SPFx v1.8, you can use either Office UI Fabric React v5 or v6. Each version of SPFx upgrades the version of Office UI Fabric React in new projects. For example:

0 commit comments

Comments
 (0)