Skip to content

Commit 3b4c7c9

Browse files
Update sharepoint-2019-support.md
1 parent 82e0373 commit 3b4c7c9

File tree

1 file changed

+28
-30
lines changed

1 file changed

+28
-30
lines changed

docs/spfx/sharepoint-2019-support.md

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,39 @@ The [Team-based development on the SharePoint Framework](team-based-development-
2929

3030
The dependencies for SPFx v1.4.1 frameworks, tools, and the associated versions don't match the same dependency matrix for the latest versions of SharePoint Framework. In these cases, you may need to install specific versions of the tools. We recommend you install Node.js v8.9.4, gulp v3.9.1, and Yeoman v2.0.6.
3131

32-
## Manuals for web part development and deployment with SharePoint Framework
33-
34-
Follow these steps for web part development and deployment with SharePoint Framework:
32+
> [!IMPORTANT]
33+
> The Yeoman generator for the SharePoint Framework, starting with v1.13.0, only supports projects for SharePoint Online. Learn more about this change in the [SharePoint Framework v1.13 release notes](release-1.13.md). However, SPFx 1.4.1 is only supported on Node.js v6 and Node.js v8. Therefore, you need to get the latest version of the Yeoman generator for the SharePoint Framework (v1.10.0) that works on the same version of Node.js (v6 or v8) that SPFx v1.4.1 is supported on. Solution structure is created then with the v1.4.1 version packages as long as you select the environmen target properly in the Yeoman generator flow.
3534
36-
1. Prepare the environment for SharePoint Framework development
37-
1. Develop SharePoint Framework web part
38-
1. Verify SharePoint Framework web part on local SharePoint workbench
39-
1. Deploy SharePoint Framework solution to the SharePoint Server
35+
## Manuals for web part development and deployment with SharePoint Framework
4036

4137
### Prepare the environment for SharePoint Framework development
4238

4339
1. Install Node.js
4440

45-
Install **Node.js v8.9.4**; if you have **nvm** installed, use **nvm** to install **8.9.4**. Verify the version if you have **Node.js** installed.
41+
Install [Node.js v8.9.4](https://nodejs.org/download/release/v8.9.4/); if you have installed nvm, you can use nvm to install `nvm install 8.9.4`
42+
43+
if you have installed Node.js, check the version
44+
45+
`node-v`
4646
1. Install Yeoman and Gulp
4747

4848
Specify these versions:
49-
- **npm install -g [email protected]**
50-
- **npm install -g [email protected]**
49+
- `npm install -g [email protected]`
50+
- `npm install -g [email protected]`
5151
1. Install Yeoman SharePoint Generator
5252

53-
**npm install3 -g @microsoft/generator-sharepoint@1.9.1**. Although not the only option, version **1.9.1** can function appropriately.
53+
`npm install-g @microsoft/generator-sharepoint@1.10.0`
5454

5555
### Develop SharePoint Framework web part
5656

57-
1. Create a directory for SharePoint Framework solution with **md spfx-webpart-onprem**.
57+
1. Create a directory for SharePoint Framework solution.
58+
`md spfx-webpart-onprem`
5859

59-
1. Navigate to the above created directory with **cd spfx-webpart-onprem**.
60+
1. Navigate to the above created directory.
61+
`cd spfx-webpart-onprem`
6062

61-
1. Run Yeoman SharePoint Generator to create the solution with **yo @microsoft/sharepoint**.
63+
1. Run Yeoman SharePoint Generator to create the solution.
64+
`yo @microsoft/sharepoint`
6265

6366
The Yeoman SharePoint generator will allow you to provide details regarding the intended solution.
6467

@@ -68,30 +71,22 @@ Follow these steps for web part development and deployment with SharePoint Frame
6871

6972
1. Select **SharePoint 2019 onwards, including SharePoint Online**.
7073

71-
Once the solution is created, select **package.json** to check if the SharePoint Framework version is 1.4.1.
74+
Once the solution is created, select package.json to check if the SharePoint Framework version is 1.4.1.
7275

7376
:::image type="content" source="../images/screenshot_2.png" alt-text="This is screenshot 2.":::
7477

7578
### Verify SharePoint Framework web part on local SharePoint workbench
7679

7780
1. Browse to the **SPFx solution** directory.
7881

79-
1. Run **gulp serve**.
82+
1. Run `gulp serve`.
8083

81-
**workbench.aspx** opens, you can add your web part to the page.
84+
workbench.aspx opens, you can add your web part to the page.
8285

8386
:::image type="content" source="../images/screenshot_3.png" alt-text="This is screenshot 3.":::
8487

8588
### Deploy SharePoint Framework solution to the SharePoint Server
8689

87-
You can deploy the SharePoint Framework solution to the SharePoint Server in these steps:
88-
89-
1. Create service applications
90-
1. Prepare .sppkg package
91-
1. Create and configure app catalog site
92-
1. Add SharePoint Framework solution to modern SharePoint site
93-
1. Add SharePoint Framework web part to modern page
94-
9590
#### Create service applications
9691

9792
Ensure the following service applications are enabled on the SharePoint Server:
@@ -113,10 +108,13 @@ New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $sa
113108

114109
#### Prepare .sppkg package
115110

116-
1. Bundle the solution with **gulp bundle --ship**.
111+
1. Bundle the solution.
112+
`gulp bundle --ship`
117113

118-
1. Package the solution with **gulp package-solution --ship**.
119-
114+
1. Package the solution.
115+
`gulp package-solution --ship`
116+
117+
Verify SharePoint Framework web part on local SharePoint workbench
120118

121119
#### Create and configure app catalog site
122120

@@ -154,7 +152,7 @@ Follow these steps to upload the SharePoint Framework package to the app catalog
154152

155153
:::image type="content" source="../images/screenshot_9.png" alt-text="This is screenshot 9.":::
156154

157-
#### Add SharePoint Framework solution to modern SharePoint site 
155+
### Add SharePoint Framework solution to modern SharePoint site 
158156

159157
Follow these steps to add your SharePoint Framework solution to modern SharePoint site:
160158

@@ -171,7 +169,7 @@ Follow these steps to add your SharePoint Framework solution to modern SharePoin
171169

172170
:::image type="content" source="../images/screenshot_12.png" alt-text="This is screenshot 12.":::
173171

174-
#### Add SharePoint Framework web part to modern page
172+
### Add SharePoint Framework web part to modern page
175173

176174
Follow these steps to add your SharePoint Framework web part to the modern page:
177175

0 commit comments

Comments
 (0)