Метаданни на страницата
Страница DevSite е единична единица съдържание на сайт. Една страница може да има заглавие, тяло, елементи на заглавка и атрибути на метаданни, които контролират функциите на сайта. Когато потребител посети URL адреса за страница, сайтът изобразява пълна уеб страница въз основа на свойствата на страницата със съдържание, като добавя динамични елементи като горен колонтитул, долен колонтитул и странична лента. Поведенията по подразбиране са оптимизирани за страници с техническа документация, но страницата може да бъде конфигурирана и за други цели, като маркетинг и целеви страници.
Структура на страница
Страница DevSite е уеб страница, чийто общ вид и характеристики се управляват от сайта. Показва се страница на Google Developers с няколко общи области. (Не всички сайтове поддържат всички функции.) Задръжте курсора на мишката върху диаграмата за етикети.
site header
Логото на сайта, приспособлението за влизане, полето за търсене и горната навигация. Често срещано в целия сайт.
project bar
Заглавието на проекта или продукта и специфични за проекта приспособления (като връзката „Обратна връзка“). Тази област се определя от метаданните на проекта .
sidebar
Йерархична навигация в цялата книга. Тази област се определя от метаданните на книгата .
body
Заглавието на страницата и съдържанието на страницата.
page footer ("last updated")
Уиджети, специфични за страницата (като известието „Последна актуализация“). Може също да съдържа известие за CC лиценз, което е атрибут на метаданни на проекта.
site footer
Връзките в долния колонтитул на сайта, джаджата за избор на език. Често срещано в целия сайт.
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>
Атрибутът devsite на елемента <html> казва на DevSite, че това трябва да бъде изобразено като страница на DevSite, а не дословно като HTML актив. Ако страницата ви се показва без форматиране или горен или долен колонтитул, проверете дали <html devsite> се показва в горната част на вашия файл.
Елементите <html> , <head> и <body> са задължителни и трябва да имат отварящи и затварящи тагове.
Типичната страница също трябва да има елемент <title> вътре в <head> . Вижте заглавието на страницата .
Специфични <meta> тагове контролират функциите на страницата. Те са описани в тази справка. Типичната страница има мета таг "project_path" , който препраща към файл с метаданни _project.yaml , и мета таг "book_path" , който препраща към файл с метаданни _book.yaml . Вижте Проекти и книги . <meta> таговете, разпознати от DevSite, обикновено не се появяват на последната страница.
Други елементи в <head> и всички елементи в <body> се изобразяват на последната страница.
Markdown изходни файлове
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Типичната страница трябва да има заглавие (напр. # Page title ). Вижте заглавието на страницата .
Специфични мета тагове контролират функциите на страницата. Те са описани в тази справка. Типичната страница има мета таг Project: който препраща към файл с метаданни _project.yaml , и мета таг Book: който препраща към файл с метаданни _book.yaml . Вижте Проекти и книги. Мета таговете, разпознати от DevSite, обикновено не се показват на последната страница.
Проекти и книги
Проектът се описва от файл с метаданни на проекта, наречен _project.yaml . Една книга се описва от файл с метаданни на книга, наречен _book.yaml . Тези файлове се публикуват на сайта заедно с файловете на страници и активи и могат да бъдат преведени на множество езици. Вижте метаданни на проекта и метаданни на книга за информация относно структурата и атрибутите на тези файлове.
За да свържете страница с проект, предоставете атрибута project_path . Стойността му е пътят на съдържанието до файла _project.yaml .
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Markdown
Project: /path/to/_project.yaml
Ако дадена страница няма атрибут project_path , тя ще бъде изобразена без региона на лентата на проекта и неговите функции. Страницата няма да се счита за част от проект.
За да свържете страница с книга, предоставете атрибута book_path . Стойността му е пътят на съдържанието до файла _book.yaml .
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Markdown
Book: /path/to/_book.yaml
Заглавие на страницата
<head>
<title>Page title</title>
...
</head>
Или използвайте елемент <h1> с класа page-title в <body> на страницата.
HTML
<h1 class="page-title">Page title</h1>
Markdown
# Page title
Началните страници на проекта не се нуждаят от заглавия,
HTML
<meta name="no_page_title" value="true" />
Markdown
no_page_title: true
В специални случаи, когато автоматичният <h1> не е желателен за специално оформление, но страницата все още се нуждае от заглавие на прозорец, можете да запазите заглавието, но да скриете заглавието с атрибута "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Markdown
hide_page_heading: true
# Page title
Описание на заглавката
Много сайтове на DevSite имат описание в заглавката. Това е зададено във файла с метаданни _project.yaml и автоматично се показва на целевите страници на DevSite. С други думи, страниците, които са създадени с помощта на шаблони _index.yaml , автоматично ще изобразят описание в заглавката, която е зададена във файла _project.yaml .
Това описание може да бъде заменено за страницата чрез задаване на description в основата на файла _index.yaml или потиснато чрез задаване на hide_description: true в обекта header на обекта landing_page .
Оформление с пълна ширина
Ако е необходим повече контрол върху оформлението, можете да кажете на DevSite да се откаже от контрола върху оформлението за областта под заглавката на сайта и лентата на проекта и над долния колонтитул на сайта. За да направите това, задайте атрибута на метаданните "full_width" на "true" .
HTML
<meta name="full_width" value="true" />
Markdown
full_width: true
Последна актуализирана дата
По подразбиране, с изключение на страници full-width , областта на долния колонтитул на страницата включва автоматично известие „последна актуализация“. В повечето случаи това дава на потребителите директен сигнал за свежестта на съдържанието на страницата.
В някои случаи тази информация може да е объркваща или да се счита за поверителна от продуктовия екип. За да деактивирате последното актуализирано известие на страница, задайте атрибута hide_last_updated на 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
Можете да замените автоматично изчислената дата на „последна актуализация“, като зададете мета маркера refresh_date на дата във формат 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" />
Markdown
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Описание на страницата
Описанието на страница е текстово резюме на съдържанието на страницата. За да зададете описание за страница, осигурете елемент <meta name="description" content="DESCRIPTION" /> . Забележете, че текстът на описанието влиза в атрибут с име content , а не value ; това съответства на уеб стандартния атрибут.
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...
Задаването на описанието на страницата води до включването на <meta> тага на последната страница
Път на изображението
image_path е пътят до изображението, което представлява тази страница в социалните медии и функциите на DevSite като recommendations и dynamic content . Когато е зададено, това изображение ще се използва като изображение на OpenGraph на страницата, заменяйки настройките на social media на проекта и настройките за брандиране tenant site's .
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Markdown
image_path: /site-assets/developers_64dp.png
Ключови думи
Полето keywords е разделен със запетаи списък от низове, които описват страницата и се използват във функции за търсене и откриване, като търсене в сайта и Dynamic Content .
Полето keywords поддържа плоски ключови думи без асоцииране на измерения (например gettingstarted ) и структурирани ключови думи, които използват пространства на имена на измерения, за да представят връзката между документи и обекти от реалния свят като езици за програмиране, продукти и събития (например product:ComputeEngine или language:Python3 ). Можете да добавите и двата вида keywords към всяко поле за ключови думи.
Ако поставите ключова дума, която не отговаря на изискванията за форматиране, ще видите предупреждение с правилно форматираната версия на вашата ключова дума в изхода на инструмента, който сте използвали (обикновено инструмента за команден ред DevSite или DevSite Content Publisher).
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Markdown
keywords: spacetime, timetravel, product:Delorean