retype icon indicating copy to clipboard operation
retype copied to clipboard

How to add Meta Description for each pages?

Open blakstrox opened this issue 2 years ago • 3 comments

I tried to add meta description using meta.description just like meta.title. But it not working.

I tried to add the below information to a page containing profile documentation and it never works

---
icon: person
title: My Profile Page
meta:
  title: "Profile Page"
  description: "Profile Meta Description"
---
# Profile

blakstrox avatar Sep 21 '23 11:09 blakstrox

The description property is on the root level, not under the meta node.

conanthedev avatar Sep 21 '23 20:09 conanthedev

As noted by @paralexm, the description should be added on the root level of the page config, which I admit is confusing.

---
icon: person
title: My Profile Page
meta:
  title: "Profile Page"
description: "Profile Meta Description"
---
# Profile

The description setting was supported since the first public release of Retype, whereas the meta.title setting was not included until recently with the v3.0.0 release.

We should likely add meta.description too and only support the root description for backwards compatibility reasons.

geoffreymcgill avatar Sep 22 '23 08:09 geoffreymcgill

I have logged adding meta.description as an enhancement request. Retype would support both settings.

We will review and try to get this included in one of the upcoming releases.

geoffreymcgill avatar Sep 22 '23 08:09 geoffreymcgill