Sivun metatiedot
DevSite-sivu on yksittäinen sisältöyksikkö sivustolla. Sivulla voi olla otsikko, leipäteksti, otsikkoelementtejä ja metatietoattribuutteja, jotka ohjaavat sivuston ominaisuuksia. Kun käyttäjä vierailee sivun URL-osoitteessa, sivusto hahmontaa täydellisen verkkosivun sisältösivun ominaisuuksien perusteella ja lisää dynaamisia elementtejä, kuten otsikon, alatunnisteen ja sivupalkin. Oletuskäyttäytymiset on optimoitu teknisen dokumentaation sivuille, mutta sivu voidaan määrittää myös muuhun käyttöön, kuten markkinointiin ja aloitussivuihin.
Sivun rakenne
DevSite-sivu on verkkosivu, jonka ulkoasua ja ominaisuuksia hallinnoi sivusto. Näkyviin tulee Google Developers -sivu, jossa on useita yhteisiä alueita. (Kaikki sivustot eivät tue kaikkia ominaisuuksia.) Vie hiiri tarrojen kaavion päälle.
site header
Sivuston logo, kirjautumiswidget, hakukenttä ja ylänavigaattori. Yleinen koko sivustolla.
project bar
Projektin tai tuotteen nimi ja projektikohtaiset widgetit (kuten "Palaute"-linkki). Tämän alueen määrittelevät projektin metatiedot .
sidebar
Kirjanlaajuinen hierarkkinen navigointi. Tämän alueen määrittelevät kirjan metatiedot .
body
Sivun otsikko ja sivun sisältö.
page footer ("last updated")
Sivukohtaiset widgetit (kuten "Viimeksi päivitetty" -ilmoitus). Saattaa sisältää myös CC-lisenssiilmoituksen, joka on projektin metatietoattribuutti.
site footer
Sivuston alatunnisteen linkit, kielen valintawidget. Yleinen koko sivustolla.
HTML-lähdetiedostot
<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>
<html> -elementin devsite attribuutti kertoo DevSite-sivustolle, että tämä tulee hahmontaa DevSite-sivuna eikä sanatarkasti HTML-sisältönä. Jos sivusi näkyy ilman muotoilua tai ylä- tai alatunnistetta, tarkista, että <html devsite> näkyy tiedoston yläosassa.
Elementit <html> , <head> ja <body> ovat pakollisia, ja niissä on oltava avaus- ja sulkemistunnisteet.
Tyypillisellä sivulla on myös oltava <title> -elementti <head> sisällä. Katso sivun otsikko .
Tietyt <meta> -tunnisteet ohjaavat sivun ominaisuuksia. Nämä on kuvattu tässä viitteessä. Tyypillisellä sivulla on "project_path" -sisällönkuvauskenttä, joka viittaa _project.yaml metatietotiedostoon, ja "book_path" -sisällönkuvauskenttä, joka viittaa _book.yaml metatietotiedostoon. Katso Projektit ja kirjat . DevSiten tunnistamat <meta> -tunnisteet eivät yleensä näy viimeisellä sivulla.
Muut <head> -elementit ja kaikki <body> -elementit renderöidään viimeisellä sivulla.
Markdown-lähdetiedostot
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Tyypillisellä sivulla on oltava otsikko (esim. # Page title ). Katso sivun otsikko .
Tietyt sisällönkuvauskentät ohjaavat sivun ominaisuuksia. Nämä on kuvattu tässä viitteessä. Tyypillisellä sivulla on Project: -sisällönkuvauskenttä, joka viittaa _project.yaml -metatietotiedostoon, ja Book: -sisällönkuvauskenttä, joka viittaa _book.yaml -metatietotiedostoon. Katso Projektit ja kirjat. DevSiten tunnistamat sisällönkuvauskentät eivät yleensä näy viimeisellä sivulla.
Projekteja ja kirjoja
Projekti kuvataan projektin metatietotiedostolla nimeltä _project.yaml . Kirjaa kuvaa kirjan metatietotiedosto nimeltä _book.yaml . Nämä tiedostot julkaistaan sivustolla yhdessä sivu- ja sisältötiedostojen kanssa, ja ne voidaan kääntää useille kielille. Katso Projektin metatiedot ja Kirjan metatiedot saadaksesi tietoja näiden tiedostojen rakenteesta ja attribuuteista.
Jos haluat liittää sivun projektiin, anna attribuutti project_path . Sen arvo on sisältöpolku _project.yaml -tiedostoon.
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Markdown
Project: /path/to/_project.yaml
Jos sivulla ei ole project_path attribuuttia, se hahmonnetaan ilman projektipalkin aluetta ja sen ominaisuuksia. Sivua ei pidetä osana projektia.
Jos haluat liittää sivun kirjaan, anna book_path -määrite. Sen arvo on _book.yaml -tiedoston sisältöpolku.
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Markdown
Book: /path/to/_book.yaml
Sivun otsikko
<head>
<title>Page title</title>
...
</head>
Tai käytä <h1> -elementtiä page-title kanssa sivun <body> -osassa.
HTML
<h1 class="page-title">Page title</h1>
Markdown
# Page title
Projektin kotisivut eivät tarvitse otsikoita,
HTML
<meta name="no_page_title" value="true" />
Markdown
no_page_title: true
Erikoistapauksissa, joissa automaattista <h1> ei haluta erityiselle asettelulle, mutta sivu tarvitsee silti ikkunan otsikon, voit säilyttää otsikon, mutta piilottaa otsikon "hide_page_heading" -attribuutilla:
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Markdown
hide_page_heading: true
# Page title
Otsikon kuvaus
Monen DevSite-sivuston otsikossa on kuvaus. Tämä asetetaan _project.yaml -metatietotiedostossa ja näytetään automaattisesti DevSite-aloitussivuilla. Toisin sanoen sivut, jotka on luotu käyttämällä _index.yaml -mallia, näyttävät automaattisesti kuvauksen otsikossa, joka on asetettu _project.yaml tiedostoon.
Tämä kuvaus voidaan ohittaa sivulla asettamalla description _index.yaml -tiedoston juureen, tai se voidaan estää asettamalla hide_description: true landing_page header .
Täysleveä asettelu
Jos asettelua tarvitaan enemmän, voit pyytää DevSitea luopumaan asettelun hallinnasta sivuston otsikon ja projektipalkin alapuolella ja sivuston alatunnisteen yläpuolella. Voit tehdä tämän asettamalla "full_width" metatietoattribuutin arvoksi "true" .
HTML
<meta name="full_width" value="true" />
Markdown
full_width: true
Viimeisin päivityspäivä
Oletusarvoisesti, paitsi full-width sivuilla, sivun alatunnistealue sisältää automaattisen "viimeksi päivitetty" -ilmoituksen. Useimmissa tapauksissa tämä antaa käyttäjille suoran signaalin sivun sisällön tuoreudesta.
Joissakin tapauksissa nämä tiedot voivat olla hämmentäviä tai tuotetiimi voi pitää niitä luottamuksellisina. Voit poistaa viimeksi päivitetyn ilmoituksen käytöstä asettamalla hide_last_updated -attribuutin arvoksi 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" />
Markdown
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true
Voit ohittaa automaattisesti lasketun "viimeksi päivitetty" -päivämäärän asettamalla refresh_date-sisällönkuvauskentän päivämääräksi ISO 8601 -muodossa:
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" />
Markdown
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Sivun kuvaus
Sivun kuvaus on tekstillinen yhteenveto sivun sisällöstä. Jos haluat määrittää sivun kuvauksen, anna <meta name="description" content="DESCRIPTION" /> elementti. Huomaa, että kuvausteksti menee attribuutissa, jonka nimi on content , ei value ; tämä vastaa web-standardiattribuuttia.
HTML
<meta name="description" content="It was the best of times, it was the blurst of times..." />
Markdown
description: It was the best of times, it was the blurst of times...
Sivun kuvauksen asettaminen saa aikaan <meta> -tunnisteen sisällyttämisen viimeiselle sivulle
Kuvan polku
image_path on polku kuvaan, joka edustaa tätä sivua sosiaalisessa mediassa ja DevSite-ominaisuuksissa, kuten recommendations ja dynamic content . Kun se on asetettu, tätä kuvaa käytetään sivun OpenGraph-kuvana, joka ohittaa projektin social media asetukset ja tenant site's brändäysasetukset.
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Markdown
image_path: /site-assets/developers_64dp.png
Avainsanat
keywords on pilkuilla eroteltu luettelo merkkijonoista, jotka kuvaavat sivua ja joita käytetään haku- ja etsintäominaisuuksissa, kuten sivustohaussa ja Dynamic Content .
keywords kenttä tukee tasaisia avainsanoja, joissa ei ole ulottuvuutta (esimerkiksi gettingstarted ) ja jäsenneltyjä avainsanoja, jotka käyttävät ulottuvuudellisia nimiavaruuksia edustamaan asiakirjojen ja todellisten kokonaisuuksien, kuten ohjelmointikielten, tuotteiden ja tapahtumien välistä suhdetta (esimerkiksi product:ComputeEngine tai language:Python3 ). Voit lisätä molempia keywords mihin tahansa avainsanakenttään.
Jos asetat avainsanan, joka ei täytä muotoiluvaatimuksia, näet käyttämäsi työkalun (yleensä DevSite-komentorivityökalun tai DevSite Content Publisherin) tulosteessa varoituksen, jossa on avainsanasi oikein muotoiltu versio.
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Markdown
keywords: spacetime, timetravel, product:Delorean