Skip to content

Commit 98c670c

Browse files
authored
[All Hosts] (devx) update syntax for sideloading on web (#4981)
1 parent 17459b5 commit 98c670c

14 files changed

+24
-24
lines changed

docs/excel/custom-functions-debugging.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Custom functions debugging in a non-shared runtime
33
description: Learn how to debug your Excel custom functions that don't use a shared runtime.
4-
ms.date: 12/26/2024
4+
ms.date: 01/03/2024
55
ms.topic: troubleshooting
66
ms.localizationpriority: medium
77
---
@@ -71,7 +71,7 @@ If you aren't using VS Code, you can use the command line (such as bash, or Powe
7171

7272
Or if you prefer to start your add-in in Excel on the web run the following command.
7373

74-
`npm run start:web -- --document {url}` (where `{url}` is the URL of an Excel file on OneDrive or SharePoint)
74+
`npm run start -- web --document {url}` (where `{url}` is the URL of an Excel file on OneDrive or SharePoint)
7575

7676
[!include[Mac command line note](../includes/mac-command-line.md)]
7777

@@ -95,7 +95,7 @@ There are several build tasks available.
9595
You can use the following tasks to start debugging on desktop or online.
9696

9797
- `npm run start:desktop`: Starts Excel on desktop and sideloads your add-in. If the "start:desktop" script isn't present in the "scripts" section of the project's package.json file, then run `npm run start` instead.
98-
- `npm run start:web -- --document {url}` (where `{url}` is the URL of an Excel file on OneDrive or SharePoint): Starts Excel on the web and sideloads your add-in.
98+
- `npm run start -- web --document {url}` (where `{url}` is the URL of an Excel file on OneDrive or SharePoint): Starts Excel on the web and sideloads your add-in.
9999

100100
[!include[Mac command line note](../includes/mac-command-line.md)]
101101

docs/includes/quickstart-yo-start-server-excel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Complete the following steps to start the local web server and sideload your add
1818
1919
- To test your add-in in Excel on a browser, run the following command in the root directory of your project. When you run this command, the local web server starts. Replace "{url}" with the URL of an Excel document on your OneDrive or a SharePoint library to which you have permissions.
2020
21-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
21+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]

docs/includes/start-web-sideload-instructions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
> If you are developing on a Mac, enclose the `{url}` in single quotation marks. Do *not* do this on Windows.
33
44
```command line
5-
npm run start:web -- --document {url}
5+
npm run start -- web --document {url}
66
```
77

88
The following are examples.
99

10-
- `npm run start:web -- --document https://contoso.sharepoint.com/:t:/g/EZGxP7ksiE5DuxvY638G798BpuhwluxCMfF1WZQj3VYhYQ?e=F4QM1R`
11-
- `npm run start:web -- --document https://1drv.ms/x/s!jkcH7spkM4EGgcZUgqthk4IK3NOypVw?e=Z6G1qp`
12-
- `npm run start:web -- --document https://contoso-my.sharepoint-df.com/:t:/p/user/EQda453DNTpFnl1bFPhOVR0BwlrzetbXvnaRYii2lDr_oQ?e=RSccmNP`
10+
- `npm run start -- web --document https://contoso.sharepoint.com/:t:/g/EZGxP7ksiE5DuxvY638G798BpuhwluxCMfF1WZQj3VYhYQ?e=F4QM1R`
11+
- `npm run start -- web --document https://1drv.ms/x/s!jkcH7spkM4EGgcZUgqthk4IK3NOypVw?e=Z6G1qp`
12+
- `npm run start -- web --document https://contoso-my.sharepoint-df.com/:t:/p/user/EQda453DNTpFnl1bFPhOVR0BwlrzetbXvnaRYii2lDr_oQ?e=RSccmNP`
1313

1414
If your add-in doesn't sideload in the document, manually sideload it by following the instructions in [Manually sideload add-ins to Office on the web](../testing/sideload-office-add-ins-for-testing.md#manually-sideload-an-add-in-to-office-on-the-web).

docs/includes/tutorial-excel-start-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ If the local web server is already running and your add-in is already loaded in
88
99
- To test your add-in in Excel on the web, run the following command in the root directory of your project. When you run this command, the local web server starts. Replace "{url}" with the URL of an Excel document on your OneDrive or a SharePoint library to which you have permissions.
1010
11-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
11+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]
1212

docs/includes/tutorial-word-start-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ If the local web server is already running and your add-in is already loaded in
88
99
- To test your add-in in Word on the web, run the following command in the root directory of your project. When you run this command, the local web server starts. Replace "{url}" with the URL of a Word document on your OneDrive or a SharePoint library to which you have permissions.
1010
11-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
11+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]
1212

docs/quickstarts/excel-custom-functions-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ To start, you'll use the Yeoman generator to create the custom functions project
4646
4747
To test your add-in in Excel on the web, run the following command. When you run this command, the local web server will start. Replace "{url}" with the URL of an Excel document on your OneDrive or a SharePoint library to which you have permissions.
4848
49-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
49+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]
5050
5151
[!INCLUDE [alert use https](../includes/alert-use-https.md)]
5252

docs/quickstarts/fluent-react-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The add-in project that you've created with the Yeoman generator contains sample
8484
8585
- To test your add-in in Excel, Word, or PowerPoint on the web, run the following command in the root directory of your project. When you run this command, the local web server starts. Replace "{url}" with the URL of a Word document on your OneDrive or a SharePoint library to which you have permissions.
8686
87-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
87+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]
8888
8989
> [!NOTE]
9090
> If this is the first time that you have sideloaded an Office add-in on your computer (or the first time in over a month), you're prompted first to delete an old certificate and then to install a new one. Agree to both prompts.

docs/quickstarts/powerpoint-quickstart-yo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ After you complete the wizard, the generator creates the project and installs su
5858
5959
- To test your add-in in PowerPoint on a browser, run the following command in the root directory of your project. When you run this command, the local web server starts. Replace "{url}" with the URL of a PowerPoint document on your OneDrive or a SharePoint library to which you have permissions.
6060
61-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
61+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]
6262
6363
1. In PowerPoint, insert a new blank slide, choose the **Home** tab, and then choose the **Show Taskpane** button on the ribbon to open the add-in task pane.
6464

docs/quickstarts/word-quickstart-yo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ After you complete the wizard, the generator creates the project and installs su
8888
8989
- To test your add-in in Word on a browser, run the following command in the root directory of your project. When you run this command, the local web server starts. Replace "{url}" with the URL of a Word document on your OneDrive or a SharePoint library to which you have permissions.
9090
91-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
91+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]
9292
9393
1. In Word, if the "My Office Add-in" task pane isn't already open, open a new document, choose the **Home** tab, and then choose the **Show Taskpane** button on the ribbon to open the add-in task pane.
9494

docs/testing/sideload-office-add-ins-for-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This process is supported for **Excel**, **OneNote**, **PowerPoint**, and **Word
3838

3939
1. Open a Command Prompt as an administrator. In the command line starting at the root directory of your project, run the following command. Replace "{url}" with the URL that you copied.
4040

41-
[!INCLUDE [npm start:web command syntax](../includes/start-web-sideload-instructions.md)]
41+
[!INCLUDE [npm start on web command syntax](../includes/start-web-sideload-instructions.md)]
4242

4343
1. The first time you use this method to sideload an add-in on the web, you'll see a dialog asking you to enable developer mode. Select the checkbox for **Enable Developer Mode now** and select **OK**.
4444

0 commit comments

Comments
 (0)