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. The main differences in my package are:

  • the overview pages for tags, pages aso are included

  • there is a stylesheet

  • used dates do not include time

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/.

Changelog

see Github release page.

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)

Contributors

Thanks to all contributers!

Bug Reporters:

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.2.0.tar.gz (18.0 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: pelican-extended-sitemap-1.2.0.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.5.6

File hashes

Hashes for pelican-extended-sitemap-1.2.0.tar.gz
Algorithm Hash digest
SHA256 524dc3e27275777eebb5bfa6ce8deb331c16d20a478404e99ed23aeaab9dab25
MD5 f674efccab36e87bb543b06ed4a7c11d
BLAKE2b-256 117f78a627b70ec8e1f2cdc13d99ac3ace8489c713fed51e4f38a5c9e644626d

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