Skip to main content

sitemap generator plugin for pelican

Project description

A sitemap plugin for Pelican.

It generates a sitemap.xml according to the specification of sitemaps.org and considers the pelican index page, articles, pages and special pages (like tags, categories, authors). Also comes with a XML stylesheet to be able to view the sitemap in browser without pain.

There is also a sitemap plugin within the official pelican plugin repo, but it did not produce the expected results for me.

NOTICE: Backwards incompatible changes in 1.0.0:

In version 1.0.0 the package naming has been fixed, it’s now called “extended_sitemap” (instead “extended-sitemap”) following PEP8. Please adjust your usages in PLUGINS appropriately.

Sources and Status

https://travis-ci.org/dArignac/pelican-extended-sitemap.svg?branch=master https://coveralls.io/repos/dArignac/pelican-extended-sitemap/badge.png?branch=master

Pelican settings

Add to the plugins list:

PLUGINS = [
    'extended_sitemap'
]

Plugin settings

Add the EXTENDED_SITEMAP_PLUGIN dict to your settings. The keys explained:

  • priorities: priority for each page type, from 0.0 to 1.0

    • index: index page

    • articles: article pages

    • pages: pages

    • others: category, tags and authors pages

  • changefrequencies: how often a page will likely change, possible values: always, hourly, daily, weekly, monthly, yearly, never

The settings below are the default values:

EXTENDED_SITEMAP_PLUGIN = {
    'priorities': {
        'index': 1.0,
        'articles': 0.8,
        'pages': 0.5,
        'others': 0.4
    },
    'changefrequencies': {
        'index': 'daily',
        'articles': 'weekly',
        'pages': 'monthly',
        'others': 'monthly',
    }
}

Tests

nose is required to run the tests. Install the package and run with the nosetest command.

The tests fixture files were created with generated content by http://jaspervdj.be/lorem-markdownum/.

ToDos

What still has to be implemented:

  • support for multilingual content, see pelican translations (it in fact may work, but I have not tested it)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican-extended-sitemap-1.0.0.tar.gz (16.5 kB view details)

Uploaded Source

File details

Details for the file pelican-extended-sitemap-1.0.0.tar.gz.

File metadata

File hashes

Hashes for pelican-extended-sitemap-1.0.0.tar.gz
Algorithm Hash digest
SHA256 dfa6753539b5e7e1d39ea068fa8e4d975f2b34fd1ea3b87543af4384824f8600
MD5 8f98bbb7da57d5cf46f28803e213062a
BLAKE2b-256 46775fae07ace9645cbc3c71c6e008a0d605c4ac3c1540f524bbe88428bdfca1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page