search

fsprojects / FSharp.Formatting

F# tools for generating documentation (Markdown processor and F# code formatter)
https://fsprojects.github.io/FSharp.Formatting/
Other
462 stars 155 forks source link

add minimal seo tags for open graph and twitter cards to default template #873

Closed kMutagene closed 7 months ago

kMutagene commented 7 months ago

see #869

This is a basic implementation using the available substitution parameters. There could be more, e.g. displaying a default image etc., but i think for that we would need additional substitutions.

Thorium commented 7 months ago

Is there something good that could be added to the meta description tag?

nojaf commented 7 months ago

Maybe we can use the Description tag from the cracked projects?

kMutagene commented 7 months ago

Maybe we can use the Description tag from the cracked projects?

I was thinking about that, but this has the same problem as fsdocs-authors has - if the respective xml tag in the cracked project does not exist, the tag will contain rubbish. However i agree that that tag would be a sensible default when it exists.

nojaf commented 7 months ago

We could also fix that part. Having better defaults or use empty strings if not replaced. Or let the tool crash in a strict mode if values are missing.