Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Update base-template/doctype-example-guide.md
Browse files Browse the repository at this point in the history
Co-authored-by: Cameron Shorter <[email protected]>
  • Loading branch information
2 people authored and Cameron Shorter committed Feb 28, 2021
1 parent 34b0e38 commit cf605a5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion base-template/doctype-example-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ This guide explains how to build a good example document for a specific `doctype
The guide is designed to be read by a template author, someone who intends to create or improve a set of templates and guides for a `doctype`.

{
Add structured metadata info to your doc template that the end user can use to describe the doc page's contents, to improve search results that feature the doc pages. If your docs are to be displayed in HTML, add a script tag to the head of the page with JSON-LD metadata, as in this example:
* Add [machine readable structured metadata](https://developers.google.com/search/docs/guides/sd-policies) to your doctype example.
* Structured metadata helps search engines index pages appropriately, and facilitates content reuse.
* Within this project we have adopted the [JSON-LD](http://json-ld.org/) format for structured metadata, [as recommended by Google](https://developers.google.com/search/docs/guides/intro-structured-data).
<!--Machine readable schema.org structured metadata about this guide.-->
``` json
<script type="application/ld+json">
Expand Down

0 comments on commit cf605a5

Please sign in to comment.