Skip to content

Commit 23a1b37

Browse files
committed
docs: add documentation about the multiple sitemaps feature
1 parent 48aa4f9 commit 23a1b37

File tree

5 files changed

+90
-0
lines changed

5 files changed

+90
-0
lines changed

.changeset/cruel-parks-wait.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"docs": minor
3+
---
4+
5+
docs: add documentation about the multiple sitemaps feature
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
sidebar_label: 'Introduction'
3+
displayed_sidebar: webtoolsSitemapSidebar
4+
slug: /addons/sitemap/expansion
5+
---
6+
7+
# Additional features
8+
9+
:::caution
10+
These additional features are part of the premium package of Webtools. You'll have to purchase a license key to download and use this package. Once you have your license key you can run the following command to setup your license in your project:
11+
12+
```
13+
npx webtools-cli setup-license
14+
```
15+
16+
To purchase a license, please visit the [PluginPal website](https://www.pluginpal.io/plugin/webtools).
17+
:::
18+
19+
Once you have a license key for Webtools you are able to use these additional Sitemap features. To start using them you'll have to install an additional package which will be used to extend the Sitemap functionality.
20+
21+
## Installation
22+
23+
Note that this package can only be installed after you've [setup your license](/cli/setup-license).
24+
25+
<Tabs groupId="yarn-npm">
26+
<TabItem value="yarn" label="Yarn">
27+
```
28+
yarn add @pluginpal/webtools-addon-sitemap-expansion
29+
```
30+
</TabItem>
31+
<TabItem value="npm" label="NPM">
32+
```
33+
npm install @pluginpal/webtools-addon-sitemap-expansion --save
34+
```
35+
</TabItem>
36+
</Tabs>
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
sidebar_label: 'Multiple Sitemaps'
3+
displayed_sidebar: webtoolsSitemapSidebar
4+
slug: /addons/sitemap/expansion/multiple-sitemaps
5+
---
6+
7+
import ThemedImage from '@theme/ThemedImage';
8+
import useBaseUrl from '@docusaurus/useBaseUrl';
9+
10+
# Multiple sitemaps
11+
12+
After you have setup your license and installed the additional Sitemap expansion you can now manage multiple Sitemaps from the Strapi admin panel. If you haven't do so yet, please [follow the instructions here](/addons/sitemap/expansion).
13+
14+
---
15+
16+
## Configuration
17+
18+
Navigate to the Sitemap settings page in your Strapi application. In your local development env you can find that on the following URL http://localhost:1337/admin/plugins/webtools/sitemap.
19+
20+
Here you are now able to see the different sitemaps that you have created. By default you will have a single sitemap already made with the name 'default'.
21+
22+
<ThemedImage
23+
alt="Custom URL"
24+
sources={{
25+
light: useBaseUrl('/webtools/img/assets/addons/sitemap/multiple-sitemaps.png'),
26+
dark: useBaseUrl('/webtools/img/assets/addons/sitemap/multiple-sitemaps.png'),
27+
}}
28+
/>
29+
30+
---
31+
32+
## Access
33+
34+
Each sitemap can be accessed individually through the REST api. The URL to access the sitemap will be as follows:
35+
36+
```bash
37+
http://localhost:1337/api/sitemap/[sitemap-name].xml
38+
```
39+
40+
In the URL as shown here, you'll have to replace `[sitemap-name]` with the actual name of the sitemap that you want to access.

packages/docs/sidebars.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,15 @@ const sidebars = {
123123
"addons/sitemap/getting-started/troubleshooting",
124124
],
125125
},
126+
{
127+
type: "category",
128+
collapsed: false,
129+
label: "✨ Additional features",
130+
items: [
131+
"addons/sitemap/expansion/introduction",
132+
"addons/sitemap/expansion/multiple-sitemaps",
133+
],
134+
},
126135
{
127136
type: "category",
128137
collapsed: false,
174 KB
Loading

0 commit comments

Comments
 (0)