Puslapio metaduomenys
DevSite puslapis yra vienas svetainės turinio vienetas. Puslapis gali turėti pavadinimą, turinį, antraštės elementus ir metaduomenų atributus, kurie valdo svetainės funkcijas. Kai vartotojas apsilanko puslapio URL, svetainė pateikia visą tinklalapį pagal turinio puslapio ypatybes, pridėdama dinaminių elementų, tokių kaip antraštė, poraštė ir šoninė juosta. Numatytoji elgsena optimizuota techninės dokumentacijos puslapiams, tačiau puslapis taip pat gali būti sukonfigūruotas kitiems tikslams, pvz., rinkodaros ir nukreipimo puslapiams.
Puslapio struktūra
DevSite puslapis yra tinklalapis, kurio bendrą išvaizdą ir funkcijas valdo svetainė. Rodomas „Google Developers “ puslapis su keliomis bendromis sritimis. (Ne visos svetainės palaiko visas funkcijas.) Užveskite pelės žymeklį ant etikečių diagramos.
site header
Svetainės logotipas, prisijungimo valdiklis, paieškos laukelis ir viršutinė navigacija. Bendras visoje svetainėje.
project bar
Projekto arba produkto pavadinimas ir su projektu susiję valdikliai (pvz., nuoroda „Atsiliepimas“). Šią sritį apibrėžia projekto metaduomenys .
sidebar
Visos knygos hierarchinė navigacija. Šią sritį apibrėžia knygos metaduomenys .
body
Puslapio pavadinimas ir puslapio turinys.
page footer ("last updated")
Puslapiui būdingi valdikliai (pvz., pranešimas „Paskutinį kartą atnaujinta“). Taip pat gali būti CC licencijos pranešimas, kuris yra projekto metaduomenų atributas.
site footer
Svetainės poraštės nuorodos, kalbos pasirinkimo valdiklis. Bendras visoje svetainėje.
HTML šaltinio failai
<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>
Elemento <html> atributas „ devsite nurodo „DevSite“, kad tai turėtų būti pateikta kaip „DevSite“ puslapis, o ne pažodžiui kaip HTML išteklius. Jei jūsų puslapis rodomas be formatavimo arba antraštės ar poraštės, patikrinkite, ar failo viršuje yra <html devsite> .
Elementai <html> , <head> ir <body> yra būtini ir turi turėti atidarymo ir uždarymo žymas.
Įprastame puslapyje taip pat turi būti elementas <title> , esantis <head> viduje. Žr. puslapio pavadinimą .
Konkrečios <meta> žymos valdo puslapio funkcijas. Jie aprašyti šioje nuorodoje. Įprastame puslapyje yra metažyma "project_path" , kuri nurodo _project.yaml metaduomenų failą, ir metažyma "book_path" , kuri nurodo _book.yaml metaduomenų failą. Žr. Projektai ir knygos . DevSite atpažintos <meta> žymos paprastai nerodomos galutiniame puslapyje.
Kiti elementai <head> ir visi elementai <body> pateikiami galutiniame puslapyje.
Markdown šaltinio failai
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Įprastas puslapis turi turėti pavadinimą (pvz., # Page title ). Žr. puslapio pavadinimą .
Konkrečios metažymos valdo puslapio funkcijas. Jie aprašyti šioje nuorodoje. Įprastas puslapis turi Project: “ metažymą, kuri nurodo _project.yaml metaduomenų failą, ir Book: “ metažymą, kuri nurodo į _book.yaml metaduomenų failą. Žr. Projektai ir knygos. DevSite atpažintos metažymos paprastai nerodomos galutiniame puslapyje.
Projektai ir knygos
Projektas aprašomas projekto metaduomenų rinkmena pavadinimu _project.yaml . Knygą apibūdina knygos metaduomenų failas, pavadintas _book.yaml . Šie failai skelbiami svetainėje kartu su puslapių ir išteklių failais ir gali būti išversti į kelias kalbas. Norėdami gauti informacijos apie šių failų struktūrą ir atributus, žr. Projekto metaduomenys ir Knygos metaduomenys.
Norėdami susieti puslapį su projektu, pateikite atributą project_path . Jo reikšmė yra turinio kelias į _project.yaml failą.
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Pažymėjimas
Project: /path/to/_project.yaml
Jei puslapis neturi project_path atributo, jis bus pateiktas be projekto juostos regiono ir jo funkcijų. Puslapis nebus laikomas projekto dalimi.
Norėdami susieti puslapį su knyga, pateikite atributą book_path . Jo reikšmė yra turinio kelias į _book.yaml failą.
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Pažymėjimas
Book: /path/to/_book.yaml
Puslapio pavadinimas
<head>
<title>Page title</title>
...
</head>
Arba naudokite elementą <h1> su page-title klase puslapio <body> .
HTML
<h1 class="page-title">Page title</h1>
Pažymėjimas
# Page title
Projekto pagrindiniams puslapiams nereikia pavadinimų,
HTML
<meta name="no_page_title" value="true" />
Pažymėjimas
no_page_title: true
Ypatingais atvejais, kai automatinis <h1> nėra pageidautinas specialiam išdėstymui, bet puslapiui vis tiek reikia lango pavadinimo, galite išlaikyti pavadinimą, bet paslėpti antraštę naudodami atributą "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Pažymėjimas
hide_page_heading: true
# Page title
Antraštės aprašymas
Daugelio „DevSite“ svetainių antraštėje yra aprašas. Tai nustatyta metaduomenų faile _project.yaml ir automatiškai rodoma DevSite nukreipimo puslapiuose. Kitaip tariant, puslapiai, sukurti naudojant _index.yaml šabloną, automatiškai pateiks aprašymą antraštėje, kuri nustatyta faile _project.yaml .
Šio puslapio aprašymo galima nepaisyti nustatant description failo _index.yaml šaknyje arba nuslopinti nustatant hide_description: true objekto landing_page header objekte.
Viso pločio išdėstymas
Jei reikia daugiau valdyti išdėstymą, galite nurodyti, kad „DevSite“ atsisakytų teritorijos po svetainės antrašte ir projekto juosta ir virš svetainės poraštės išdėstymo valdymo. Norėdami tai padaryti, nustatykite metaduomenų atributą "full_width" į "true" .
HTML
<meta name="full_width" value="true" />
Pažymėjimas
full_width: true
Paskutinio atnaujinimo data
Pagal numatytuosius nustatymus, išskyrus full-width puslapius, puslapio poraštės srityje yra automatinis pranešimas „paskutinį kartą atnaujinta“. Daugeliu atvejų tai suteikia vartotojams tiesioginį signalą apie puslapio turinio naujumą.
Kai kuriais atvejais ši informacija gali būti paini arba produkto komanda ją gali laikyti konfidencialia. Norėdami išjungti paskutinį atnaujintą pranešimą puslapyje, atributą hide_last_updated nustatykite į 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" />
Pažymėjimas
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true
Galite nepaisyti automatiškai apskaičiuotos „paskutinį kartą atnaujintos“ datos, nustatydami metažymą refresh_date į datą ISO 8601 formatu:
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" />
Pažymėjimas
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Puslapio aprašymas
Puslapio aprašymas yra tekstinė puslapio turinio santrauka. Norėdami nustatyti puslapio aprašą, pateikite elementą <meta name="description" content="DESCRIPTION" /> . Atkreipkite dėmesį, kad aprašo tekstas yra atribute, pavadintame content , o ne value ; tai atitinka žiniatinklio standarto atributą.
HTML
<meta name="description" content="It was the best of times, it was the blurst of times..." />
Pažymėjimas
description: It was the best of times, it was the blurst of times...
Nustačius puslapio aprašą, <meta> žyma įtraukiama į galutinį puslapį
Vaizdo kelias
image_path yra kelias į vaizdą, kuris atstovauja šiam puslapiui socialinėje medijoje ir „DevSite“ funkcijose, pvz., recommendations ir dynamic content . Nustačius šis vaizdas bus naudojamas kaip puslapio „OpenGraph“ vaizdas, nepaisydamas projekto social media ir tenant site's prekės ženklo nustatymų.
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Pažymėjimas
image_path: /site-assets/developers_64dp.png
Raktažodžiai
keywords laukas yra kableliais atskirtas eilučių, apibūdinančių puslapį ir naudojamas paieškos ir atradimo funkcijose, pvz., svetainės paieškoje ir Dynamic Content sąrašas.
keywords lauke palaikomi plokštieji raktiniai žodžiai be matmenų susiejimo (pvz., gettingstarted ) ir struktūriniai raktiniai žodžiai, kurie naudoja matmenų vardų erdves, kad atspindėtų ryšį tarp dokumentų ir realaus pasaulio objektų, pvz., programavimo kalbų, produktų ir įvykių (pvz., product:ComputeEngine arba language:Python3 ). Į bet kurį raktinių žodžių lauką galite įtraukti abiejų tipų keywords .
Jei nustatysite raktinį žodį, kuris neatitinka formatavimo reikalavimų, naudojamo įrankio (dažniausiai komandinės eilutės įrankio „DevSite“ arba „DevSite Content Publisher“) išvestyje pamatysite įspėjimą su tinkamai suformatuota raktinio žodžio versija.
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Pažymėjimas
keywords: spacetime, timetravel, product:Delorean