Skip to content

Commit b1eb85c

Browse files
committed
authored customizing default site designs
1 parent 1845925 commit b1eb85c

File tree

4 files changed

+58
-15
lines changed

4 files changed

+58
-15
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Customize default site designs on SharePoint
3+
description: Customize the default site designs in either the SharePoint team site or communications site template
4+
ms.date: 12/18/2017
5+
---
6+
7+
# Customize a default site design
8+
9+
> [!NOTE]
10+
> Site designs and site scripts are currently in preview and are subject to change. They are not currently supported for use in production environments.
11+
12+
SharePoint contains several site designs already available in the SharePoint Online site templates. These are the default site designs. You can modify them using PowerShell or the REST APIs to control the entire site provisioning experience. For example, you can ensure that your company theme is applied to every site that gets created. Or you can make sure a logging mechanism always runs regardless of which site design is chosen.
13+
14+
## Apply a site design to the default site designs
15+
16+
To customize the default site designs, apply a new one with the Powershell **Add-SPOSiteDesign** cmdlet, or the **CreateSiteDesign** REST API. Specify the **IsDefault** switch to apply the site design as default.
17+
18+
The following example shows how to use the **IsDefault** switch to apply the Contoso company theme to the default site designs. The site script referenced by ID contains the JSON script to apply the correct theme.
19+
20+
```powershell
21+
C:\> Add-SPOSiteDesign `
22+
-Title "Contoso company theme" `
23+
-WebTemplate "68" `
24+
-SiteScripts "89516c6d-9f4d-4a57-ae79-36b0c95a817b" `
25+
-Description "Applies standard company theme to site" `
26+
-IsDefault
27+
```
28+
```javascript
29+
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.CreateSiteDesign", {info:{Title:"Contoso company theme", Description:"Applies standard company theme to site", SiteScriptIds:["89516c6d-9f4d-4a57-ae79-36b0c95a817b"], WebTemplate:"68", IsDefault: true}});
30+
```
31+
32+
## Which default site designs are updated?
33+
34+
In the previous example, the **WebTemplate** value of "68" refers to the SharePoint Online communication site template. That template contains the following default site designs:
35+
36+
- Topic
37+
- Showcase
38+
- Blank
39+
40+
When you apply a new site design, it will update all three of the default site designs at the same time.
41+
42+
The SharePoint Online team site template contains only one default site design named **Team**. In this case when you apply a default site design, only the **Team** site design is updated.
43+
44+
## Restoring the default site designs
45+
46+
To restore a site design to the defaults, remove the site design you applied. In the previous example, if the site design created had the ID db752673-18fd-44db-865a-aa3e0b28698e, you would remove it as shown in the following example.
47+
48+
```powershell
49+
C:\> Remove-SPOSiteDesign db752673-18fd-44db-865a-aa3e0b28698e
50+
```
51+
```javascript
52+
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteDesign", {id:"db752673-18fd-44db-865a-aa3e0b28698e"});
53+
```
54+
55+
> [!NOTE]
56+
> If you're not sure which site design is the default, run the **Get-SPOSiteDesign** cmdlet. It will list all site designs, and indicates which ones are defaults.

docs/declarative-customization/site-design-apply-default-template.md

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

docs/declarative-customization/site-design-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ These are the default site designs. For each site design there is a title, descr
3434

3535
![Default site design title, description, and image on communication site template](images/site-designs-listed-on-communication-site-template.png)
3636

37-
Had you chosen the team site template, it contains only one default site design named **Team site**. <!-- For additional information on how you can change the default site designs, see [Applying a site design to a default SharePoint template](site-design-apply-default-template.md). -->
37+
Had you chosen the team site template, it contains only one default site design named **Team site**. For additional information on how you can change the default site designs, see [Applying a site design to a default SharePoint template](customize-default-site-design.md).
3838

3939
Once a site design is selected, SharePoint creates the new site, and runs site scripts for the site design. The site scripts detail the work such as creating new lists, or applying a theme. When the actions in the scripts are completed, SharePoint displays detailed results of those actions in a progress pane.
4040

docs/declarative-customization/site-design-powershell.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,7 @@ C:\> Add-SPOSiteDesign `
7878
-SiteScripts "<ID>" `
7979
-Description "Tracks key customer data in a list" `
8080
-PreviewImageUrl "https://contoso.sharepoint.com/SiteAssets/site-preview.png" `
81-
-PreviewImageAltText "site preview" `
82-
-IsDefault $false
81+
-PreviewImageAltText "site preview"
8382
```
8483

8584
## **Add-SPOSiteScript**

0 commit comments

Comments
 (0)