Yet Another Static Site (Generator) Documentation

Configuring Pages

Table of Contents

General informations

At this moment, all configuration for each page is inside files with page content. They have syntax: [CommentMark] [Key]: [Value]. Default setting for the [CommendMark] is -- but you can change it in site.cfg file.

^ Top

Page configuration

Available settings for each page:

If you have enabled creation of sitemap in the project config file, you can set some sitemap parameters too. All sitemap parameter are optional. More informations about how sitemap parameters works, you can find at Sitemaps protocol page. All sitemap settings are optional.

If you enabled creation of Atom feed in the project config file, you can some Atom feed parameters too. How much and how it works, depends on selected source of the Atom feed. All of this parameters can be used as a normal page tags too. More informations about how Atom feeds parameters works, you can find at Introduction to Atom

If you selected source of the Atom feed as tags:

Example of markdown file with Atom feed settings for Atom feed source as tags:

-- layout: default
-- title: awesome text about something
Here is super awesome text.

If you selected source of the Atom feed as [filename] and this markdown file will be used as a source for the Atom feed:

Example of markdown file test.md with Atom feed settings for Atom feed source as test.md:

-- layout: news
-- title: []
-- id: []
-- updated: []
-- news: []
-- title: third news
-- id: latest
-- updated: 2019-02-23T10:05:00Z
-- authoremail: jondoe@example.com
-- author: Jon Doe
-- news: This is the latest news.
-- id: third
-- updated: 2019-02-23T10:02:00Z
-- news: This is the third news.
-- title: second news
-- id: second
-- updated: 2019-02-23T10:00:00Z
-- authoremail: jondoe@example.com
-- news: This is the second news.
-- title: first news
-- id: first
-- updated: 2019-02-23T09:59:00Z
-- author: Jon Doe
-- news: This is the first news.

And use TABLE statement inside news.html layout to show that news:

<!DOCTYPE html>
<html lang="en">
  <head>
     <meta charset="UTF-8">
     <title>News</title>
  </head>
  <body>
     @@TABLE@@
        <h2>{%title%}<a name="{%id%}"></a></h2>
        <p>{%NO_LETTER:updated%}</p>
        <p>{%news%}</p>
     @@END_TABLE@@
  </body>
</html>

One parameter is always required:

^ Top

<< Site Config
Index