Giter Club home page Giter Club logo

docpad-plugin-sitemap's Introduction

Sitemap Plugin for DocPad

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

This DocPad plugin will automatically generate a valid sitemap.xml file for search engines. It's merely a wrapper for the sitemap.js library.

This project was forked from the solid start made by Khalid Jebbari.

To learn more about sitemap.xml files, read the protocol.

Usage

For each document, you can specify the following metadata:

changefreq: 'always' || 'hourly' || 'daily' || 'weekly' || 'monthly' || 'yearly' || 'never' # Change frequency, defaults to 'weekly'
priority: 0.5 # value between 0.0 and 1.0, defaults to 0.5
sitemap: true || false # defaults to true, if false no entry for this document will be generated

For the whole site you can set defaults using the plugin configuration in your docpad.cson or docpad.coffee file.

	templateData:
		site:
			url: "http://your-website-production-url.com"  # required for sitemap

	plugins:
		sitemap:
			cachetime: 600000
			changefreq: 'weekly'
			priority: 0.5
			filePath: 'sitemap.xml'

By default all HTML files on your site will be considered for inclusion. To specify a different collection, change the collectionName plugin configuration option like so:

	plugins:
		sitemap:
			collectionName: 'someCollectionName'

Install

Install this DocPad plugin by entering docpad install sitemap into your terminal.

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

docpad-plugin-sitemap's People

Contributors

apoleshchuk avatar balupton avatar benjamind avatar brockfanning avatar delapouite avatar dependabot[bot] avatar djebbz avatar nathanbowser avatar phaseone avatar robloach avatar vsopvsop avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docpad-plugin-sitemap's Issues

Preventing some files like the 404 page being added

How do I prevent entries like these from being in the sitemap.xml -surely it doesn't make sense:

<url>
<loc>http://www.a1footballfactory.com/404</loc>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>http://www.a1footballfactory.com/500</loc>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>

DocPad crashes with "NoURLProtocolError: Protocol is required" after installing

Not sure what's going on here. I tried adding my site URL to both plugins.sitemap.hostname and templateData.site.url, with and without "http://", and it doesn't seem to make a difference.

I tried running docpad run --debug, and that gets me debug output from docpad but not any plugins, but I think that's a bug in docpad.

Update: this was due to having the string 'http' in the path of one of my urls - the current sitemap.js release sees that and then fails to add the site protocol and hostname, and then chokes later when the URL doesn't have one.

Plugin configuration for the whole site not working

Changed the docpad.coffee file to configure for the whole site but no changes made.
Works for each document when specify in metadata, but not with plugin config in docpad.coffee.
Any suggestions?
eg

    plugins:
      sitemap:
        cachetime: 600000
        changefreq: 'monthly'
        priority: 1.0
        filePath: 'sitemap.xml'

No out folder in node_modules

After running npm install docpad-plugin-sitemap there is no out folder created in the sitemap fodler and docpad fails to load the plugin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.