Skip to content

Site description template tags #160

@stuartmaxwell

Description

@stuartmaxwell

Need two new template tags for the SITE_DESCRIPTION option:

  • site_description - similar to the site_title tag, this just returns SITE_DESCRIPTION option as a string.
  • meta_description - returns a <meta name="description" HTML tag with the SITE_DESCRIPTION as the content.

Future docs:


site_description

Returns the site description as configured in the settings with the SITE_DESCRIPTION variable. If no site description has been
configured, this will return the default: "" (i.e. an empty string)

Returns: the SITE_DESCRIPTION value as a string.

Related Topics: See configuration.md for how to configure the site description and other settings.

site_description Example

This can be used to include your blog's description in your header or sidebar, and can also be used for the HTML meta tag (although the meta_description tag is recommended for this):

<meta name="description" content="{% site_description %}">

This will output:

<meta name="description" content="My blog's description!">

meta_description

Returns the <meta name="description" HTML tag with the SITE_DESCRIPTION as the content, or returns an empty string if the SITE_DESCRIPTION hasn't been configured.

Returns: the meta tag as HTML which has been marked as safe, or an empty string if SITE_DESCRIPTION hasn't been configured.

meta_description Example

This can be used to include the meta description tag, or will include an empty string if SITE_DESCRIPTION hasn't been configured.

{% meta_description %}

This will output:

<meta name="description" content="My blog's description!">

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

Status

Ready

Relationships

None yet

Development

No branches or pull requests

Issue actions