Sign Up

Footer Customization

Footer links and social media profilesFooter links and social media profiles

You can customize your footer of your documentation with external links and social media profile buttons.

Footer links

You can add a list of links to your footer in your doctave.yaml under the footer field.

doctave.yaml
footer:
  links:
    - label: Dashboard
      external: https://www.example.com
    - label: API Status
      external: https://www.example.com
    - label: Pricing
      external: https://www.example.com
    - label: Blog
      external: https://www.example.com

Social media profiles

You can also add one prominent call-to-action button in your footer. They will be rendered with the appropriate logo for the platform. The supported platforms are linkedin, twitter, github, facebook, and discord

doctave.yaml
footer:
  github: https://www.github.com/AcmeInc
  twitter: https://www.twitter.com/AcmeInc
  linkedin: https://www.linkedin.com/company/AcmeInc
  discord: https://www.discord.com/invite-link/AcmeInc
  facebook: https://www.facebook.com/AcmeInc

Doctave doesn't assume a URL structure for social media profile links. Use the full URL appropriate for each platform.

Was this page helpful?