dashdev-website/build/start/page-definitions/index.html
2020-03-06 13:24:42 +01:00

137 lines
No EOL
4.1 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Page definitions - dashdevs-suite</title>
<meta name="description" content="How pages are defined in the source folder." />
<meta name="HandheldFriendly" content="true">
<meta name="MobileOptimized" content="320">
<meta name="viewport" content="width=device-width,shrink-to-fit=no,user-scalable=no,initial-scale=1,minimum-scale=1,minimal-ui">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="mobile-web-app-capable" content="yes">
<link rel="stylesheet" media="all" href="../../css/styles.css" />
</head>
<body>
<header>
<div class="content">
<p class="logo"><a href="../../">dashdevs-suite</a></p>
<!-- main navigation -->
<nav class="nav main">
<ul>
<li>
<a href="../../">Home</a>
</li>
<li>
<a href="../../start/" class="active">Start</a>
</li>
<li>
<a href="../../article/">Articles</a>
</li>
<li>
<a href="../../contact/">Contact</a>
</li>
</ul>
</nav>
</div>
</header>
<main class="subpages" >
<div class="content">
<!-- sub navigation -->
<nav class="nav sub">
<ul>
<li>
<a href="../../start/installation/">Installation</a>
</li>
<li>
<a href="../../start/build/">Build</a>
</li>
<li>
<a href="../../start/site-files/">Site files</a>
</li>
<li>
<strong>Page definitions</strong>
</li>
<li>
<a href="../../start/plugins/">Custom plugins</a>
</li>
</ul>
</nav>
<article>
<h1>Page definitions</h1>
<p class="articleinfo">Published 3 March 2020, 194 words, 1-minute read</p>
<p>Each sub-folder in <code>src/html</code> is a website section. Pages named <code>index.md</code> are the default page in section. File paths are translated to permalinks, e.g.</p>
<pre><code>src/html/article/mypage.md</code></pre><p>is rendered to:</p>
<pre><code>build/article/mypage/index.html</code></pre><p>Pages use YAML front-matter defined at the top. This can be referenced in templates or during the build process, e.g.</p>
<pre><code>---
title: My page title
description: A description of this page for meta tags and page lists.
layout: page.html
priority: 0.9
publish: 2016-06-01
date: 2016-06-01
---</code></pre><p>All items are optional. Note:</p>
<ul>
<li><code>layout</code> defaults to <code>page.html</code> unless <code>metadata.layout</code> is defined for the page collection (see the <code>use(collections({ ... })</code> code in <code>build.js</code>).</li>
<li><code>priority</code> is a number between 0 (low) and 1 (high) which is used to order menus and define XML sitemaps.</li>
<li><code>publish</code> can be set <code>draft</code>, <code>private</code> or a future date to ensure it is not published until required.</li>
<li><code>date</code> is the date of the article. If not set, a future <code>publish</code> date or the file creation date is used.</li>
</ul>
<p>The page content is defined in markdown, HTML syntax or both below the front-matter section. The content can include <a href="http://handlebarsjs.com/">Handlebars</a> partials from the <code>src/partials</code> folder, e.g.</p>
<pre><code>{{&gt; partialname }}</code></pre><p>where <code>partialname</code> is the partial filename without its <code>.html</code> extension.</p>
<nav class="nav page">
<ul>
<li><a href="../../start/site-files/" class="back">&laquo; back: Site files</a></li>
</p>
<li><a href="../../start/plugins/" class="next">next: Custom plugins &raquo;</a></li>
</p>
</ul>
</nav>
</article>
</div>
</main>
<footer>
<p>Help make this page better. <a href="https://github.com/dashdev-suite/dashdev-website/tree/master/src">Edit here</a></p>
<!-- <p>By <a href="https://chat.dashdevs.org">dashdevs</a> and featured on <a href="http://www.dashdevs.org/">DashDevs.org</a></p> -->
<!-- <p class="siteinfo">Development build, version 1.0.0, article template</p> -->
</footer>
</body>
</html>