Add SEO to Your Router

This article demonstrates how to configure SEO for your router pages. There are 2 parts to setting up the SEO:

1. Create meta tags for Google to learn about your pages.
2. Create a sitemap for Google to use to find your pages.

Step 1 | Set meta tags for router pages

To set SEO meta tags for your router's pages:

1. In your router.js file, create an object that contains your desired SEO settings inside the router() function. This becomes the HeadOptions object that you pass to the router page.

   The sample code below contains several properties that are set using the data it retrieves in the router() function, including the following:

   • The title property, which contains the page's SEO title.
   • The description property, which contains a short description of the page's content.
   • A noIndex flag, set to false. This tells Google that it should index your page.
   • Additional meta tags contained in the metaTags property. You can add meta tags to this property.
   Copy

   Keep or remove these properties, and add your own as needed.

   Note: The HeadOptions object can also contain a keywords property, but Google ignores your site's keywords.

2. Specify the HeadOptions object as the third parameter in the ok() function. This object is then sent to the router page so that Google has SEO information for it.

   Copy

Step 2 | Create the sitemap for your router

To add your router pages to your sitemap:

1. In your router's sitemap() function, create a WixRouterSitemapEntry object for each URL the router can possibly route to.

   Each WixRouterSitemapEntry in the code example below includes the router page's URL, title, and name. The example groups them into an array.

   Copy

2. Return all the sitemap entries to create the router sitemap. For example:

   Copy

Step 3 | Check your router sitemap

To ensure that your sitemap is working properly, you can get the sitemap from your published site:

1. In your web browser, go to your published site's URL and append /sitemap.xml to it.

   • For premium sites, if your site's published URL is: https://mysite.com, go to: https://mysite.com/sitemap.xml.
   • For free sites, if your site's published URL is https://username.wixsite.com/site-name, go to https://username.wixsite.com/site-name/sitemap.xml.

2. Check that the sitemap matches the layout of your router pages.

See also

• Create a router
• About routers
• Tutorial: Create dynamic pages with a custom router