Skip to content

Commit

Permalink
Fixes admonitions
Browse files Browse the repository at this point in the history
  • Loading branch information
milanholemans committed Jan 3, 2024
1 parent 106388a commit 4388d3c
Show file tree
Hide file tree
Showing 27 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/docs/cmd/adaptivecard/adaptivecard-send.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The predefined card is automatically adjusted based on which options have been s

If your custom card is a card template (card with placeholders like `${title}`), you can fill it with data either by specifying the complete data object using the `cardData` option, or by passing any number of arbitrary options that will be mapped onto the card. The arbitrary properties should not match any of the global options like `output`, `query`, `debug`, etc. Data options like `title`, `description`, `imageUrl` and `actionUrl` will be mapped onto the card as well.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--card` and `--cardData` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The schema extension owner is the ID of the Azure AD application that is the own

The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The lifecycle state of the schema extension. The initial state upon creation is
Possible states transitions are from `InDevelopment` to `Available` and `Available` to `Deprecated`.
The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites

Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ m365 spo applicationcustomizer set --webUrl https://contoso.sharepoint.com/sites

Note, how the clientSideComponentProperties option (--clientSideComponentProperties) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/commandset/commandset-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ m365 spo commandset add --webUrl https://contoso.sharepoint.com/sites/test --tit

Note, how the clientSideComponentProperties option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/commandset/commandset-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ m365 spo commandset set --webUrl https://contoso.sharepoint.com/sites/test --tit

Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/contenttype/contenttype-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ m365 spo contenttype set [options]

## Remarks

:::warning Updating child content types
:::warning[Updating child content types]

When specifying the `--updateChildren` flag, SharePoint will only propagate the changes that are made in the current request. If you want to know more about updating a content type and propagating changes to child content types, be sure to [read more here](https://learn.microsoft.com/previous-versions/office/developer/sharepoint-2010/ms442695(v=office.14)#considerations-when-updating-child-content-types).

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/customaction/customaction-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Note, how the clientSideComponentProperties option (-p) has escaped double quote

The `--rights` option accepts **case sensitive** values.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/customaction/customaction-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The `--rights` option accepts **case-sensitive** values.

Note, specifying the scope option might speed up the execution of the command, but would not update the scope. If the scope has to be changed, then the existing custom action should be removed and new should be added with different scope.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/field/field-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ m365 spo field set [options]

Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When updating column formatting for a field with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/list/list-view-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin

When updating list formatting, the value of the CustomFormatter property must be XML-escaped, eg. `&lt;` instead of `<`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When updating list view formatting for a view with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/listitem/listitem-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ m365 spo listitem add [options]

## Remarks

:::warning When using DateTime fields
:::warning[When using DateTime fields]

When creating a list item with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/listitem/listitem-batch-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMe
Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|[email protected]'}],"[{'Key':'i:0#.f|membership|[email protected]'},{'Key':'i:0#.f|membership|[email protected]'}]","https://bing.com, URL",5,2023-01-01 10:00:00
```

:::warning When using DateTime fields
:::warning[When using DateTime fields]

When creating list items with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/listitem/listitem-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ m365 spo listitem set [options]

## Remarks

:::warning When using DateTime fields
:::warning[When using DateTime fields]

When updating a list item with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/page/page-clientsidewebpart-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g

To add a standard web part to the page, specify one of the following values: _ContentRollup, BingMap, ContentEmbed, DocumentEmbed, Image, ImageGallery, LinkPreview, NewsFeed, NewsReel, PowerBIReportEmbed, QuickChart, SiteActivity, VideoEmbed, YammerEmbed, Events, GroupCalendar, Hero, List, PageTitle, People, QuickLinks, CustomMessageRegion, Divider, MicrosoftForms, Spacer_.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--webPartProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/page/page-control-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ m365 spo page control set [options]

If the specified `pageName` doesn't refer to an existing modern page, you will get a `File doesn't exists` error.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--webPartProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/cmd/spo/page/page-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ m365 spo page set --name page.aspx --webUrl https://contoso.sharepoint.com/sites

Note, how the content option has escaped double quotes `'[{\"controlType\": 4,\"id\": \"42b8afe8-dafe-4c11-bfbf-df5ef5b1feb7\",\"position\": {\"layoutIndex\": 1,\"zoneIndex\": 1,\"sectionIndex\": 1,\"sectionFactor\": 12,\"controlIndex\": 1},\"addedFromPersistedData\": true,\"innerHTML\":\"<p>Hello World</p>\"}]'` compared to execution from bash `''[{"controlType": 4,"id": "42b8afe8-dafe-4c11-bfbf-df5ef5b1feb7","position": {"layoutIndex": 1,"zoneIndex": 1,"sectionIndex": 1,"sectionFactor": 12,"controlIndex": 1},"addedFromPersistedData": true,"innerHTML":"<p>Hello World</p>"}]'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--content` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
When using the `--content` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ m365 spo tenant applicationcustomizer add --title "YourAppCustomizer" --clientSi

Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ m365 spo tenant applicationcustomizer set --id 3 --clientSideComponentProperties

Note, how the clientSideComponentProperties option (--clientSideComponentProperties) has escaped double quotes `'{\"someProperty\":\"Some value\"}'` compared to execution from bash `'{"someProperty": "Some value"}'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ m365 spo tenant commandset add --title "YourAppCustomizer" --clientSideComponent

Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ m365 spo tenant commandset set [options]

## Remarks

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/term/term-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ m365 spo term add [options]

## Remarks

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--customProperties` and/or `--localCustomProperties` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/term/term-group-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ m365 spo term group add [options]

## Remarks

:::warning
:::warning

To use this command without the `--webUrl` option you must have permissions to access the tenant admin site.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/spo/term/term-set-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ m365 spo term set add [options]

## Remarks

:::warning Escaping JSON in PowerShell
:::warning[Escaping JSON in PowerShell]

When using the `--customProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contribute/environment-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Setting up your local copy of the project for development and testing is essential. Follow the steps below to configure your environment.

:::info Install prerequisites
:::info[Install prerequisites]

Before you start contributing to this project, you will need **node@20** and **npm@10** installed.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/user-guide/using-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Some options are required and necessary for the particular command to execute, w

Some options in the CLI expect boolean values like `true` or `false`. The CLI for Microsoft 365 has the following definition for booleans:

:::info Definition of Booleans
:::info[Definition of Booleans]

Booleans are case-insensitive and are represented by the following values.
True: 1, yes, true, on
Expand Down

0 comments on commit 4388d3c

Please sign in to comment.