Skip to content

Commit

Permalink
Update guide-to-blogs-metadata.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ronniec91 authored Feb 10, 2025
1 parent 4bec5fb commit 9faee2d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion guide-to-blogs-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ html_meta:

## Metadata Structure

Ensure that you have all of the metadata fields as listed below. Correct metadata is required for internal linting and scraping tools, proper metadata is also key for internal and external search optimizations. Please note that the description field under html_meta, "description lang=en": "blog snippet text/abstract" will need to be changed with the description provided by the author, usually a brief synopsis of the blog (150 characters max), anything additional characters after the 150 mark will be cut.
Ensure that you have all of the metadata fields as listed below. Correct metadata is required for internal linting

Check failure on line 22 in guide-to-blogs-metadata.md

View workflow job for this annotation

GitHub Actions / Documentation / Markdown

Trailing spaces

guide-to-blogs-metadata.md:22:115 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md009.md
and scraping tools, proper metadata is also key for internal and external search optimizations. Please note that

Check failure on line 23 in guide-to-blogs-metadata.md

View workflow job for this annotation

GitHub Actions / Documentation / Markdown

Trailing spaces

guide-to-blogs-metadata.md:23:113 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md009.md
the description field under html_meta, "description lang=en": "blog snippet text/abstract" will need to be changed

Check failure on line 24 in guide-to-blogs-metadata.md

View workflow job for this annotation

GitHub Actions / Documentation / Markdown

Trailing spaces

guide-to-blogs-metadata.md:24:115 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md009.md
with the description provided by the author, usually a brief synopsis of the blog (150 characters max), anything

Check failure on line 25 in guide-to-blogs-metadata.md

View workflow job for this annotation

GitHub Actions / Documentation / Markdown

Trailing spaces

guide-to-blogs-metadata.md:25:113 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md009.md
additional characters after the 150 mark will be cut.

```markdown
---
Expand Down

0 comments on commit 9faee2d

Please sign in to comment.