SEO

SEO is an abbreviate for "Search Engine Optimization". Exactpro Docs Toolkit has functionality of adding description and keywords for Google search console.

Configuration

Add seo section to app.config.ts file of your docs website, using following template:

export default defineAppConfig({
  exactproDocs: {
    seo: {
      description:
        '1-2 sentences to briefly describe content of your website',
      baseUrl: 'default base URL of your website'
      keywords: ['keyword1', 'keyword2', 'keyword3'],
      robots: [{ UserAgent: '*' }, { Allow: '/' }],
      sitemap: {
        baseUrl: 'base URL of your website specified for sitemap'
      },
      verificationMetaTags: [
        {
          name: 'google-site-verification',
          content: 'google-search-console-token'
        }
      ]
    }
  }
})

Google Analytics

It's also worth mentioning, that Docs Toolkit has functionality of GTAG configuration:

export default defineAppConfig({
  exactproDocs: {
    gtag: {
      measurementId: 'your measurement id should be placed here'
    }
  }
})

You can use app.config.ts of our documentation as another example of SEO configuration!

Fields description

Option	Type	Description
`description`	`string`	Provide 1-2 sentences to briefly describe content of your website. They will be displayed under the link to your website in search results.
`baseUrl`	`string`	Default base URL for SEO properties. It will be used as a default value for sitemap, robots.txt, and Open Graph tags.
`keywords`	`array`	Here you should pass all keywords that describes your website as an array, they will be used to characterise your website for search engine.
`robots`	`array`	Configuration for `robots.txt`. See the page to see more details and examples of available features.
`sitemap.baseUrl`	`string`	Base URL for sitemap. All links in sitemap will be relative to this URL.
`verificationMetaTags`	`array`	Here you should specify name and content of meta tag, that required for verification of your resource in some search engine. See the page about verification meta tags configuration for Google search engine.

Edit this page Create issue