Lapas metadati
DevSite lapa ir viena vietnes satura vienība. Lapai var būt nosaukums, pamatteksts, galvenes elementi un metadatu atribūti, kas kontrolē vietnes funkcijas. Kad lietotājs apmeklē lapas URL, vietne, pamatojoties uz satura lapas rekvizītiem, atveido pilnīgu tīmekļa lapu, pievienojot dinamiskus elementus, piemēram, galveni, kājeni un sānjoslu. Noklusējuma darbības ir optimizētas tehniskās dokumentācijas lapām, taču lapu var konfigurēt arī citiem lietojumiem, piemēram, mārketinga un galvenajām lapām.
Lapas struktūra
DevSite lapa ir tīmekļa lapa, kuras vispārējo izskatu un funkcijas pārvalda vietne. Tiek parādīta lapa pakalpojumā Google Developers ar vairākām kopīgām zonām. (Ne visas vietnes atbalsta visas funkcijas.) Novietojiet peles kursoru virs diagrammas, lai redzētu etiķetes.
site header
Vietnes logotips, pierakstīšanās logrīks, meklēšanas lodziņš un augšējā navigācija. Izplatīts visā vietnē.
project bar
Projekta vai produkta nosaukums un projekta logrīki (piemēram, saite "Atsauksmes"). Šo apgabalu nosaka projekta metadati .
sidebar
Grāmatas mēroga hierarhiska navigācija. Šo apgabalu nosaka grāmatas metadati .
body
Lapas nosaukums un lapas saturs.
page footer ("last updated")
Lapai specifiski logrīki (piemēram, paziņojums "Pēdējo reizi atjaunināts"). Var saturēt arī CC licences paziņojumu, kas ir projekta metadatu atribūts.
site footer
Vietnes kājenes saites, valodas atlases logrīks. Izplatīts visā vietnē.
HTML avota faili
<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>
Elementa devsite atribūts devsite norāda <html> ka tā ir jāatveido kā DevSite lapa, nevis burtiski kā HTML līdzeklis. Ja jūsu lapa tiek rādīta bez formatējuma vai galvenes vai kājenes, pārbaudiet, vai faila augšdaļā ir redzams <html devsite> .
Elementi <html> , <head> un <body> ir obligāti, un tiem ir jābūt sākuma un aizvēršanas tagiem.
Parastajā lapā ir jābūt arī elementam <title> , kas atrodas <head> iekšpusē. Skatiet lapas nosaukumu .
Īpaši <meta> tagi kontrolē lapas funkcijas. Tie ir aprakstīti šajā atsaucē. Parastai lapai ir metatags "project_path" , kas attiecas uz _project.yaml metadatu failu, un metatags "book_path" , kas attiecas uz _book.yaml metadatu failu. Skatiet projektus un grāmatas . DevSite atpazītie <meta> tagi parasti neparādās pēdējā lapā.
Pārējie elementi <head> un visi elementi <body> tiek renderēti pēdējā lapā.
Markdown avota faili
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Tipiskai lapai ir jābūt nosaukumam (piem., # Page title ). Skatiet lapas nosaukumu .
Konkrēti meta tagi kontrolē lapas funkcijas. Tie ir aprakstīti šajā atsaucē. Tipiskā lapā ir metatags Project: kas attiecas uz _project.yaml metadatu failu, un Book: metatags, kas attiecas uz _book.yaml metadatu failu. Skatiet projektus un grāmatas. DevSite atpazītie metatagi parasti neparādās pēdējā lapā.
Projekti un grāmatas
Projektu apraksta projekta metadatu fails ar nosaukumu _project.yaml . Grāmatu apraksta grāmatas metadatu fails ar nosaukumu _book.yaml . Šie faili tiek publicēti vietnē kopā ar lapu un līdzekļu failiem, un tos var tulkot vairākās valodās. Informāciju par šo failu struktūru un atribūtiem skatiet sadaļā Projekta metadati un Grāmatas metadati .
Lai saistītu lapu ar projektu, norādiet atribūtu project_path . Tā vērtība ir satura ceļš uz failu _project.yaml .
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Markdown
Project: /path/to/_project.yaml
Ja lapai nav atribūta project_path , tā tiks renderēta bez projekta joslas reģiona un tā līdzekļiem. Lapa netiks uzskatīta par projekta daļu.
Lai saistītu lapu ar grāmatu, norādiet atribūtu book_path . Tā vērtība ir satura ceļš uz failu _book.yaml .
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Markdown
Book: /path/to/_book.yaml
Lapas nosaukums
<head>
<title>Page title</title>
...
</head>
Vai izmantojiet elementu <h1> ar page-title klasi lapas <body> .
HTML
<h1 class="page-title">Page title</h1>
Markdown
# Page title
Projektu mājas lapām nav nepieciešami virsraksti,
HTML
<meta name="no_page_title" value="true" />
Markdown
no_page_title: true
Īpašos gadījumos, kad automātiskais <h1> nav vēlams īpašam izkārtojumam, bet lapai joprojām ir nepieciešams loga nosaukums, varat paturēt virsrakstu, bet paslēpt virsrakstu ar atribūtu "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Markdown
hide_page_heading: true
# Page title
Virsraksta apraksts
Daudzu DevSite vietņu galvenē ir apraksts. Tas ir iestatīts metadatu failā _project.yaml un tiek automātiski parādīts DevSite galvenajās lapās. Citiem vārdiem sakot, lapas, kas izveidotas, izmantojot veidni _index.yaml , galvenē automātiski atveidos aprakstu, kas ir iestatīts failā _project.yaml .
Šo lapas aprakstu var ignorēt, iestatot description faila _index.yaml saknē, vai izslēgt, iestatot hide_description: true objekta landing_page header objektā.
Pilna platuma izkārtojums
Ja ir nepieciešama lielāka kontrole pār izkārtojumu, varat likt DevSite atteikties no kontroles pār izkārtojumu apgabalam zem vietnes galvenes un projekta joslas un virs vietnes kājenes. Lai to izdarītu, metadatu atribūtam "full_width" iestatiet vērtību "true" .
HTML
<meta name="full_width" value="true" />
Markdown
full_width: true
Pēdējās atjaunināšanas datums
Pēc noklusējuma, izņemot full-width lapas, lapas kājenes apgabalā ir iekļauts automātisks paziņojums "pēdējā atjaunināšana". Vairumā gadījumu tas lietotājiem sniedz tiešu signālu par lapas satura svaigumu.
Dažos gadījumos šī informācija var būt mulsinoša vai produktu komanda to var uzskatīt par konfidenciālu. Lai lapā atspējotu pēdējo atjaunināto paziņojumu, atribūtam hide_last_updated iestatiet vērtību 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
Varat ignorēt automātiski aprēķināto "pēdējās atjaunināšanas" datumu, iestatot metatagu refresh_date uz datumu ISO 8601 formātā:
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
Lapas apraksts
Lapas apraksts ir lapas satura teksta kopsavilkums. Lai iestatītu lapas aprakstu, norādiet elementu <meta name="description" content="DESCRIPTION" /> . Ņemiet vērā, ka apraksta teksts tiek iekļauts atribūtā ar nosaukumu content , nevis value ; tas atbilst tīmekļa standarta atribūtam.
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...
Iestatot lapas aprakstu, pēdējā lapā tiek iekļauts tags <meta>
Attēla ceļš
image_path ir ceļš uz attēlu, kas attēlo šo lapu sociālajos saziņas līdzekļos un DevSite funkcijās, piemēram, recommendations un dynamic content . Kad tas ir iestatīts, šis attēls tiks izmantots kā lapas OpenGraph attēls, ignorējot projekta social media iestatījumus un tenant site's zīmola iestatījumus.
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Markdown
image_path: /site-assets/developers_64dp.png
Atslēgvārdi
keywords lauks ir ar komatu atdalīts virkņu saraksts, kas apraksta lapu un tiek izmantotas meklēšanas un atklāšanas funkcijās, piemēram, vietnes meklēšanā un Dynamic Content .
keywords lauks atbalsta plakanos atslēgvārdus bez dimensiju saistīšanas (piemēram, gettingstarted ) un strukturētus atslēgvārdus, kas izmanto dimensiju nosaukumvietas, lai attēlotu attiecības starp dokumentiem un reālās pasaules entītijām, piemēram, programmēšanas valodām, produktiem un notikumiem (piemēram, product:ComputeEngine vai language:Python3 ). Abu veidu keywords varat pievienot jebkuram atslēgvārdu laukam.
Ja ievietojat atslēgvārdu, kas neatbilst formatēšanas prasībām, izmantotā rīka (parasti komandrindas rīka DevSite vai DevSite satura izdevēja) izvadā tiks parādīts brīdinājums ar pareizi formatētu atslēgvārda versiju.
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Markdown
keywords: spacetime, timetravel, product:Delorean