Metadata stránky
Stránka DevSite je jedna jednotka obsahu na webu. Stránka může mít nadpis, tělo, prvky záhlaví a atributy metadat, které řídí funkce webu. Když uživatel navštíví adresu URL stránky, web vykreslí kompletní webovou stránku na základě vlastností stránky s obsahem a přidá dynamické prvky, jako je záhlaví, zápatí a postranní panel. Výchozí chování je optimalizováno pro stránky technické dokumentace, ale stránku lze nakonfigurovat i pro jiné použití, jako je marketing a vstupní stránky.
Struktura stránky
Stránka DevSite je webová stránka, jejíž obecný vzhled a funkce jsou spravovány webem. Zobrazí se stránka na Google Developers s několika společnými oblastmi. (Ne všechny stránky podporují všechny funkce.) Umístěte ukazatel myši na diagram a zobrazí se štítky.
site header
Logo webu, widget pro přihlášení, vyhledávací pole a horní navigace. Společné na celém webu.
project bar
Název projektu nebo produktu a widgety specifické pro projekt (jako je odkaz „Zpětná vazba“). Tato oblast je definována metadaty projektu .
sidebar
Hierarchická navigace v celé knize. Tato oblast je definována metadaty knihy .
body
Název stránky a obsah stránky.
page footer ("last updated")
Widgety specifické pro stránku (například upozornění „Poslední aktualizace“). Může také obsahovat upozornění na licenci CC, což je atribut metadat projektu.
site footer
Odkazy na zápatí webu, widget pro výběr jazyka. Společné na celém webu.
zdrojové soubory HTML
<html devsite>
<head>
<title>Page title</title>
<meta name="project_path" value="/path/to/_project.yaml" />
<meta name="book_path" value="/path/to/_book.yaml" />
</head>
<body>
<p>Body content goes here, implemented as HTML.</p>
</body>
</html>
Atribut devsite prvku <html> sděluje DevSite, že by měl být vykreslen jako stránka DevSite a ne doslovně jako prvek HTML. Pokud se vaše stránka zobrazuje bez formátování nebo záhlaví či zápatí, zkontrolujte, zda se v horní části souboru zobrazuje <html devsite> .
Prvky <html> , <head> a <body> jsou povinné a musí mít otevírací a uzavírací značky.
Typická stránka musí mít také prvek <title> uvnitř <head> . Viz Název stránky .
Funkce stránky řídí specifické značky <meta> . Ty jsou popsány v tomto odkazu. Typická stránka má značku metadat "project_path" , která odkazuje na soubor metadat _project.yaml , a značku metadat "book_path" , která odkazuje na soubor metadat _book.yaml . Viz Projekty a knihy . Značky <meta> rozpoznané webem DevSite se na poslední stránce obvykle neobjeví.
Ostatní prvky v <head> a všechny prvky v <body> jsou vykresleny na poslední stránce.
Zdrojové soubory Markdown
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Typická stránka musí mít nadpis (např. # Page title ). Viz Název stránky .
Specifické meta tagy řídí funkce stránky. Ty jsou popsány v tomto odkazu. Typická stránka má značku metadat Project: která odkazuje na soubor metadat _project.yaml , a značku metadat Book: která odkazuje na soubor metadat _book.yaml . Viz Projekty a knihy. Meta tagy, které DevSite rozpozná, se na poslední stránce obvykle neobjeví.
Projekty a knihy
Projekt je popsán souborem metadat projektu s názvem _project.yaml . Kniha je popsána souborem metadat knihy s názvem _book.yaml . Tyto soubory jsou publikovány na webu spolu se soubory stránek a aktiv a lze je přeložit do více jazyků. Informace o struktuře a atributech těchto souborů naleznete v části Metadata projektu a metadata knihy .
Chcete-li přidružit stránku k projektu, zadejte atribut project_path . Jeho hodnota je cesta k obsahu k souboru _project.yaml .
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Snížení
Project: /path/to/_project.yaml
Pokud stránka nemá atribut project_path , bude vykreslena bez oblasti panelu projektu a jejích funkcí. Stránka nebude považována za součást projektu.
Chcete-li přiřadit stránku ke knize, zadejte atribut book_path . Jeho hodnota je cesta obsahu k souboru _book.yaml .
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Snížení
Book: /path/to/_book.yaml
Název stránky
<head>
<title>Page title</title>
...
</head>
Nebo použijte element <h1> s třídou page-title v <body> stránky.
HTML
<h1 class="page-title">Page title</h1>
Snížení
# Page title
Domovské stránky projektu nepotřebují názvy,
HTML
<meta name="no_page_title" value="true" />
Snížení
no_page_title: true
Ve zvláštních případech, kdy automatické <h1> není žádoucí pro speciální rozvržení, ale stránka přesto potřebuje název okna, můžete ponechat nadpis, ale skrýt nadpis pomocí atributu "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Snížení
hide_page_heading: true
# Page title
Popis záhlaví
Mnoho webů DevSite má v záhlaví popis. To se nastavuje v souboru metadat _project.yaml a automaticky se zobrazuje na vstupních stránkách DevSite. Jinými slovy, stránky vytvořené pomocí šablony _index.yaml automaticky vykreslí popis v záhlaví, který je nastaven v souboru _project.yaml .
Tento popis lze pro stránku přepsat nastavením description v kořenovém adresáři souboru _index.yaml nebo potlačit nastavením hide_description: true v objektu header objektu landing_page .
Rozložení po celé šířce
Pokud je potřeba větší kontrola nad rozložením, můžete DevSite sdělit, aby se vzdal kontroly nad rozložením pro oblast pod záhlavím webu a pruhem projektu a nad zápatím webu. Chcete-li tak učinit, nastavte atribut metadat "full_width" na "true" .
HTML
<meta name="full_width" value="true" />
Snížení
full_width: true
Datum poslední aktualizace
Ve výchozím nastavení, kromě stránek full-width , oblast zápatí stránky obsahuje automatické upozornění „poslední aktualizace“. Ve většině případů to dává uživatelům přímý signál o aktuálnosti obsahu na stránce.
V několika případech mohou být tyto informace matoucí nebo mohou být produktovým týmem považovány za důvěrné. Chcete-li zakázat upozornění na poslední aktualizaci na stránce, nastavte atribut hide_last_updated na true :
HTML
<meta name="project_path" value="/time-travel/_project.yaml" />
<meta name="book_path" value="/time-travel/_book.yaml" />
<meta name="hide_last_updated" value="true" />
Snížení
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true
Automaticky vypočítané datum „poslední aktualizace“ můžete přepsat nastavením metaznačky refresh_date na datum ve formátu ISO 8601 :
HTML
<meta name="project_path" value="/time-travel/_project.yaml" />
<meta name="book_path" value="/time-travel/_book.yaml" />
<meta name="refresh_date" value="2017-03-27" />
Snížení
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Popis stránky
Popis stránky je textové shrnutí obsahu stránky. Chcete-li nastavit popis stránky, zadejte prvek <meta name="description" content="DESCRIPTION" /> . Všimněte si, že popisný text jde do atributu s názvem content , nikoli value ; to odpovídá atributu webového standardu.
HTML
<meta name="description" content="It was the best of times, it was the blurst of times..." />
Snížení
description: It was the best of times, it was the blurst of times...
Nastavení popisu stránky způsobí, že značka <meta> bude zahrnuta na poslední stránce
Cesta obrázku
image_path je cesta k obrázku, který představuje tuto stránku v sociálních médiích a funkcích webu DevSite, jako jsou recommendations a dynamic content . Po nastavení bude tento obrázek použit jako obrázek OpenGraph stránky a přepíše nastavení social media projektu a nastavení značky tenant site's .
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Snížení
image_path: /site-assets/developers_64dp.png
Klíčová slova
Pole keywords je čárkami oddělený seznam řetězců, které popisují stránku a používají se ve funkcích vyhledávání a objevování, jako je vyhledávání na webu a Dynamic Content .
Pole keywords podporuje plochá klíčová slova bez asociace rozměrů (například gettingstarted ) a strukturovaná klíčová slova, která používají dimenzionální jmenné prostory k reprezentaci vztahu mezi dokumenty a entitami reálného světa, jako jsou programovací jazyky, produkty a události (například product:ComputeEngine nebo language:Python3 ). Oba typy keywords můžete přidat do libovolného pole klíčových slov.
Pokud vytvoříte klíčové slovo, které nesplňuje požadavky na formátování, zobrazí se ve výstupu nástroje, který jste použili (obvykle nástroj příkazového řádku DevSite nebo DevSite Content Publisher), varování se správně naformátovanou verzí vašeho klíčového slova.
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Snížení
keywords: spacetime, timetravel, product:Delorean