Last 10 blog posts
{{blog.pages(page)}} {% endblock %} ``` [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/parent.md 0000664 0000000 0000000 00000000212 14475343162 0021323 0 ustar 00root root 0000000 0000000 # parent: Page one level above in the site hierarchy Page one level above in the site hierarchy [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/related.md 0000664 0000000 0000000 00000000560 14475343162 0021460 0 ustar 00root root 0000000 0000000 # related: Readonly mapping of pages related to this page, indexed by name. If there are no related pages, `page.meta.related` will be guaranteed to exist as an empty dictionary. Features can add to this. For example, [syndication](syndication.md) can add `meta.related.archive`, `meta.related.rss`, and `meta.related.atom`. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/series.md 0000664 0000000 0000000 00000000266 14475343162 0021335 0 ustar 00root root 0000000 0000000 # series: List of categories for the `series` taxonomy. Setting this as a simple string is the same as setting it as a list of one element. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/series_title.md 0000664 0000000 0000000 00000000406 14475343162 0022532 0 ustar 00root root 0000000 0000000 # series_title: Series title from this page onwards. If this page is part of a series, and it defines `series_title`, then the series title will be changed to this, from this page onwards, but not for the previous pages [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/site_name.md 0000664 0000000 0000000 00000000531 14475343162 0022002 0 ustar 00root root 0000000 0000000 # site_name: Name of the site. If missing, it defaults to the title of the toplevel index page. If missing, it defaults to the name of the content directory. Name of the site. If missing, it defaults to the title of the toplevel index page. If missing, it defaults to the name of the content directory. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/site_url.md 0000664 0000000 0000000 00000000300 14475343162 0021656 0 ustar 00root root 0000000 0000000 # site_url: Base URL for the site, used to generate an absolute URL to the page. Base URL for the site, used to generate an absolute URL to the page. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/syndicated.md 0000664 0000000 0000000 00000000264 14475343162 0022170 0 ustar 00root root 0000000 0000000 # syndicated: Set to true if the page can be included in a syndication, else to false. If not set, it defaults to the value of `indexed`. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/syndication.md 0000664 0000000 0000000 00000002620 14475343162 0022363 0 ustar 00root root 0000000 0000000 # syndication: Defines syndication for the contents of this page. It is a structure which can contain normal metadata, plus: * `add_to`: chooses which pages will include a link to the RSS/Atom feeds. By default, the link is added to all syndicated pages. If this is `False`, then no feed is added to pages. If it is a dictionary, it selects pages in the site, similar to the `site_pages` function in [templates](templates.md). See [Selecting pages](page-filter.md) for details. * `archive`: if not false, an archive link will be generated next to the page. It can be set of a dictionary of metadata to be used as defaults for the generated archive page. It defaults to True. Any other metadata found in the structure are used when generating pages for the RSS/Atom feeds, so you can use `title`, `template_title`, `description`, and so on, to personalize the feeds. The pages that go in the feed are those listed in [`page.meta.pages`](doc/reference/pages.md), keeping into account the [`syndicated` and `syndication_date` page metadata](doc/reference/metadata.md). When rendering RSS/Atom feed pages, `page.meta.pages` is replaced with the list of syndicated pages, sorted with the most recent first. Setting `syndication` to true turns on syndication with all defaults, equivalent to: ```yaml syndication: add_to: yes archive: template: archive.html ``` [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/syndication_date.md 0000664 0000000 0000000 00000000614 14475343162 0023361 0 ustar 00root root 0000000 0000000 # syndication_date: Syndication date for this page. This is the date that will appear in RSS and Atom feeds, and the page will not be syndicated before this date. Use this field to publish a date today but make it appear in syndication only at some point in the future. If a page is syndicated and `syndication_date` is missing, it defaults to `date`. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/tags.md 0000664 0000000 0000000 00000000262 14475343162 0020775 0 ustar 00root root 0000000 0000000 # tags: List of categories for the `tags` taxonomy. Setting this as a simple string is the same as setting it as a list of one element. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/taxonomy.md 0000664 0000000 0000000 00000000166 14475343162 0021720 0 ustar 00root root 0000000 0000000 # taxonomy: Structured taxonomy information Structured taxonomy information [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/template.md 0000664 0000000 0000000 00000000435 14475343162 0021654 0 ustar 00root root 0000000 0000000 # template: Template used to render the page. Defaults to `page.html`, although specific pages of some features can default to other template names. Use this similarly to [Jekill's layouts](https://jekyllrb.com/docs/step-by-step/04-layouts/). [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/template_copyright.md 0000664 0000000 0000000 00000000563 14475343162 0023746 0 ustar 00root root 0000000 0000000 # template_copyright: jinja2 template to use to generate `copyright` when it is not explicitly set. The template context will have `page` available, with the current page. The result of the template will not be further escaped, so you can use HTML markup in it. If missing, defaults to `"© {{meta.date.year}} {{meta.author}}"` [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/template_description.md 0000664 0000000 0000000 00000000464 14475343162 0024261 0 ustar 00root root 0000000 0000000 # template_description: jinja2 template to use to generate `description` when it is not explicitly set. The template context will have `page` available, with the current page. The result of the template will not be further escaped, so you can use HTML markup in it. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/template_title.md 0000664 0000000 0000000 00000000450 14475343162 0023052 0 ustar 00root root 0000000 0000000 # template_title: jinja2 template to use to generate `title` when it is not explicitly set. The template context will have `page` available, with the current page. The result of the template will not be further escaped, so you can use HTML markup in it. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/title.md 0000664 0000000 0000000 00000000714 14475343162 0021162 0 ustar 00root root 0000000 0000000 # title: Page title. If missing: * it is generated via template_title, if present * the first title found in the page contents is used. * in the case of jinaj2 template pages, the contents of `{% block title %}`, if present, is rendered and used. * if the page has no title, the title of directory indices above this page is inherited. * if still no title can be found, the site name is used as a default. [Back to reference index](../README.md) staticsite-2.4/doc/reference/fields/width.md 0000664 0000000 0000000 00000000113 14475343162 0021151 0 ustar 00root root 0000000 0000000 # width: Image width Image width [Back to reference index](../README.md) staticsite-2.4/doc/reference/front-matter.md 0000664 0000000 0000000 00000002112 14475343162 0021207 0 ustar 00root root 0000000 0000000 # Front matter Front matter in staticsite[^1] is arbitrary key/value data stored in [JSON](https://en.wikipedia.org/wiki/JSON), [YAML](https://en.wikipedia.org/wiki/YAML), or [toml](https://en.wikipedia.org/wiki/TOML) format. It is the way used to add metadata in [markdown](markdown.md), [data](data.md), and [jinja2](jinja2.md) pages. If metadata starts with `---`, it is read as YAML. If it starts with `+++` it is read as TOML. If it starts with `{`, it is read as JSON. For documentation on possible metadata contents, see [Common page metadata](metadata.md) ## Example YAML front matter in a markdown page ```yaml --- title: Page with metadata in YAML format --- page contents ``` ## Example JSON front matter in a Jinja2 page ```jinja2 {% block front_matter %} { "title": "Page with metadata in JSON format" } {% endblock %} {% block content %} ... {% endblock %} ``` ## Example TOML data page ```toml +++ title = "Page with metadata in TOML format" ``` [^1]: Inspired from [Hugo front matter](https://gohugo.io/content/front-matter/) [Back to reference index](README.md) staticsite-2.4/doc/reference/page-filter.md 0000664 0000000 0000000 00000002752 14475343162 0020776 0 ustar 00root root 0000000 0000000 # Selecting site pages Functions like `site_pages` in [templates](templages.md) or `filter`/`add_to` in [syndication](syndication.md) allow selecting pages from the site. These parameters can be used to choose pages: * `path`: glob or regular expression that matches the file name in the site contents directory. It is used as a file glob (like `"blog/*"`), unless it starts with `^` or ends with `$`: then it is considered a regular expression. * `sort`: order the results according to the given metadata item. Prepend a dash (`-`) for reverse sorting. Use `url` or `-url` to sort by the url of the page in the website. * `limit` is the maximum number of pages to return. * `root` is a path limiting matching pages to those under it. You can use `"/"` to match from the site root. By default it is the path of the directory containing the page from which the search is made. Any taxonomy defined in the site becomes a possible parameter for filtering, and is a list of categories of that taxonomy: pages must have all those categories to be selected. Note that in many cases, you may want to omit `sort` and `limit` from `site_pages` and page front matter, and decide sorting and limit in templates with [the `arrange()` filter](templates.md). ## Example: List blog articles about Debian in a template: ```jinja2 {% for page in site_pages(path="blog/*", tags=["debian"], sort="-date") %}
{% block content %}
{% endblock %}
{% block footer %}
{% endblock %}