Sidans metadata
En DevSite-sida är en enda enhet av innehåll på en webbplats. En sida kan ha en titel, en text, rubrikelement och metadataattribut som styr funktionerna på webbplatsen. När en användare besöker webbadressen för en sida renderar webbplatsen en komplett webbsida baserat på innehållssidans egenskaper, och lägger till dynamiska element som sidhuvud, sidfot och sidofält. Standardbeteenden är optimerade för sidor med teknisk dokumentation, men en sida kan också konfigureras för annan användning, såsom marknadsföring och målsidor.
Struktur på en sida
En DevSite-sida är en webbsida vars allmänna utseende och funktioner hanteras av webbplatsen. En sida på Google Developers visas med flera gemensamma områden. (Alla webbplatser stöder inte alla funktioner.) Håll muspekaren över diagrammet för etiketter.
site header
Webbplatsens logotyp, inloggningswidget, sökruta och toppnavigering. Vanligt på hela webbplatsen.
project bar
Projektet eller produkttiteln och projektspecifika widgets (som länken "Feedback"). Detta område definieras av projektets metadata .
sidebar
Bokomfattande hierarkisk navigering. Detta område definieras av bokmetadata .
body
Sidans titel och innehållet på sidan.
page footer ("last updated")
Sidspecifika widgetar (som meddelandet "Senast uppdaterad"). Kan även innehålla ett CC-licensmeddelande, som är ett projektmetadataattribut.
site footer
Sidfoten länkar, språkvalswidgeten. Vanligt på hela webbplatsen.
HTML-källfiler
<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>
devsite attributet för <html> -elementet talar om för DevSite att detta ska renderas som en DevSite-sida och inte ordagrant som en HTML-tillgång. Om din sida visas utan formatering eller sidhuvud eller sidfot, kontrollera att <html devsite> visas nära toppen av filen.
Elementen <html> , <head> och <body> krävs och måste ha öppnings- och stängningstaggar.
En typisk sida måste också ha ett <title> -element, inuti <head> . Se sidans titel .
Specifika <meta> metataggar styr sidfunktioner. Dessa beskrivs i denna referens. En typisk sida har en "project_path" -metatagg, som hänvisar till en _project.yaml metadatafil, och en "book_path" -metatagg, som hänvisar till en _book.yaml metadatafil. Se Projekt och böcker . <meta> -taggar som känns igen av DevSite visas vanligtvis inte på den sista sidan.
Andra element i <head> och alla element i <body> renderas på den sista sidan.
Markdown källfiler
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
En typisk sida måste ha en titel (t.ex. # Page title ). Se sidans titel .
Specifika metataggar styr sidfunktioner. Dessa beskrivs i denna referens. En typisk sida har en Project: -metatagg, som hänvisar till en _project.yaml -metadatafil, och en Book: -metatagg, som hänvisar till en _book.yaml metadatafil. Se Projekt och böcker. Metataggar som känns igen av DevSite visas vanligtvis inte på den sista sidan.
Projekt och böcker
Ett projekt beskrivs av en projektmetadatafil med namnet _project.yaml . En bok beskrivs av en bokmetadatafil med namnet _book.yaml . Dessa filer publiceras på webbplatsen tillsammans med sid- och tillgångsfiler och kan översättas till flera språk. Se Projektmetadata och Bokmetadata för information om strukturen och attributen för dessa filer.
För att associera en sida med ett projekt, ange attributet project_path . Dess värde är innehållssökvägen till filen _project.yaml .
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Prissänkning
Project: /path/to/_project.yaml
Om en sida inte har ett project_path attribut, kommer den att renderas utan projektfältsområdet och dess funktioner. Sidan kommer inte att betraktas som en del av ett projekt.
För att associera en sida med en bok, ange attributet book_path . Dess värde är innehållssökvägen till filen _book.yaml .
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Prissänkning
Book: /path/to/_book.yaml
Sidans titel
<head>
<title>Page title</title>
...
</head>
Eller använd ett <h1> -element med klassen page-title i <body> på sidan.
HTML
<h1 class="page-title">Page title</h1>
Prissänkning
# Page title
Projekthemsidor behöver inga titlar,
HTML
<meta name="no_page_title" value="true" />
Prissänkning
no_page_title: true
I speciella fall där den automatiska <h1> inte önskas för en speciell layout men en sida fortfarande behöver en fönstertitel, kan du behålla titeln men dölja rubriken med attributet "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Prissänkning
hide_page_heading: true
# Page title
Rubrikbeskrivning
Många DevSite-webbplatser har en beskrivning i rubriken. Detta ställs in i metadatafilen _project.yaml och visas automatiskt på DevSites målsidor. Med andra ord, sidor som skapas med _index.yaml -mall kommer automatiskt att återge en beskrivning i rubriken, som ställs in i filen _project.yaml .
Den här beskrivningen kan åsidosättas för sidan genom att sätta en description i roten av filen _index.yaml , eller undertryckas genom att ställa in hide_description: true i header objektet för landing_page objektet.
Full bredd layout
Om mer kontroll över layouten behövs kan du be DevSite att avstå från kontrollen över layouten för området under sidans sidhuvud och projektfältet och ovanför sidans sidfot. För att göra det, ställ in metadataattributet "full_width" till "true" .
HTML
<meta name="full_width" value="true" />
Prissänkning
full_width: true
Senast uppdaterad datum
Som standard, förutom på sidor full-width , innehåller sidfotsområdet ett automatiskt meddelande om "senast uppdaterad". I de flesta fall ger detta användarna en enkel signal om hur färskt innehållet på sidan är.
I några få fall kan denna information vara förvirrande eller kan betraktas som konfidentiell av produktteamet. För att inaktivera det senast uppdaterade meddelandet på en sida, ställ in hide_last_updated attributet till 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" />
Prissänkning
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true
Du kan åsidosätta det automatiskt beräknade datumet "senast uppdaterad" genom att ställa in metataggen refresh_date till ett datum i ISO 8601 format:
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" />
Prissänkning
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Sidbeskrivning
Beskrivningen av en sida är en textmässig sammanfattning av sidans innehåll. För att ställa in en beskrivning för en sida, ange ett <meta name="description" content="DESCRIPTION" /> element. Lägg märke till att beskrivningstexten går i ett attribut med namnet content , inte value ; detta matchar webbstandardattributet.
HTML
<meta name="description" content="It was the best of times, it was the blurst of times..." />
Prissänkning
description: It was the best of times, it was the blurst of times...
Att ställa in sidbeskrivningen gör att <meta> -taggen inkluderas på den sista sidan
Bildväg
image_path är sökvägen till bilden som representerar den här sidan i sociala medier och DevSite-funktioner som recommendations och dynamic content . När den är inställd kommer den här bilden att användas som sidans OpenGraph-bild och åsidosätter projektets inställningar för social media och tenant site's varumärkesinställningar.
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Prissänkning
image_path: /site-assets/developers_64dp.png
Nyckelord
keywords är en kommaavgränsad lista med strängar som beskriver sidan och som används i sök- och upptäcktsfunktioner som webbplatssökning och Dynamic Content .
keywords stöder platta nyckelord utan dimensionell association (till exempel gettingstarted ) och strukturerade nyckelord som använder dimensionella namnrymder för att representera förhållandet mellan dokument och verkliga enheter som programmeringsspråk, produkter och händelser (till exempel product:ComputeEngine eller language:Python3 ). Du kan lägga till båda typerna av keywords i valfritt sökordsfält.
Om du iscensätter ett nyckelord som inte överensstämmer med formateringskraven kommer du att se en varning med den korrekt formaterade versionen av ditt sökord i utdata från det verktyg du har använt (vanligtvis kommandoradsverktyget DevSite eller DevSite Content Publisher).
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Prissänkning
keywords: spacetime, timetravel, product:Delorean