Skip to content

mkdocs.yaml

Shani Ranasinghe edited this page Dec 18, 2020 · 1 revision
  • This is the main config file.
  • site_url - refers to the canonical URL, hence should always point to the latest documentation space.
  • Strict: True - fails the build on warnings.
  • Nav section: this section includes information architecture. If new documentation is added, an entry has to be added to this section.
  • Redirects: If the location of a document has changed, a redirection rule can be added here, to automatically redirect the old URL to the new URL.