Footer Customization
![Footer links and social media profiles](https://doctave-assets-prod.s3.eu-central-1.amazonaws.com/assets/1/1/W1w85pfOEf9FsfZDHbRvJVOvFXh-rtvBk5-wjb4t2Wk/footer-light.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA5SVLUIAJSXFDENFN%2F20240722%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240722T000000Z&X-Amz-Expires=604800&X-Amz-Signature=cbbc920e147da096477e2fd0a0c5acfc782c814d9d1c2f2448605c41bac9e584&X-Amz-SignedHeaders=host&x-id=GetObject)
![Footer links and social media profiles](https://doctave-assets-prod.s3.eu-central-1.amazonaws.com/assets/1/1/xx16AQapEdSjeW4mURabcMl2j4qEcl3QzYBzRTZSVRQ/footer-dark.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA5SVLUIAJSXFDENFN%2F20240722%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240722T000000Z&X-Amz-Expires=604800&X-Amz-Signature=61d3a565250c3075e66c177eec2e6eed3eac162b05d30708c0a72290fc779513&X-Amz-SignedHeaders=host&x-id=GetObject)
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.