Closed
Description
We need to add <meta>
tags to the output of sphinx documentation.
It looks like this is supported using the meta
directive
https://docutils.sourceforge.io/docs/ref/rst/directives.html#meta
Example:
.. meta::
:description: The reStructuredText plaintext markup language
:keywords: plaintext, markup language
Some meta tags we should have:
title
description
Some advice according to: https://ahrefs.com/blog/seo-meta-tags/
Title meta:
- Write a unique title tag for each page;
- Be brief, but descriptive;
- Avoid generic and vague titles;
- Use sentence case or title case;
- Create something click-worthy—not clickbait;
- Match search intent;
- Include your target keyword where it makes sense;
- Keep it under 60 characters.
Description meta:
- Write a unique description for each page;
- Try to summarize content accurately;
- Avoid generic descriptions;
- Use sentence case;
- Create something click-worthy, not clickbait;
- Match search intent;
- Include your target keyword where it makes sense;
- Keep it under 160 characters
Metadata
Metadata
Assignees
Labels
No labels
Projects
Status
Done