Code Monkey home page Code Monkey logo

kerouac-sitemap's Introduction

kerouac-sitemap

Kerouac middleware that generates sitemaps, informing search engines about pages that are available for crawling.

Install

$ npm install kerouac-sitemap

Usage

Declare a sitemap.xml route, using this middleware.

var sitemap = require('kerouac-sitemap');

site.page('/sitemap.xml', sitemap());

Map a sitemap.xml file when generating the site.

site.generate([
  sitemap.createMapper()
]);

Indexes

For a site that consists of multiple sections, each section can have its own sitemap with each sitemap listed in a sitemap index.

var sitemap = require('kerouac-sitemap');

var site = kerouac();

var docs = kerouac();
docs.page('/sitemap.xml', sitemap());

site.use('/docs', docs);
site.page('/sitemap.xml', sitemap());
site.page('/sitemap_index.xml', sitemap.index());

site.generate({
  '/docs': [
    sitemap.createMapper(),
  ],
  '/': [
    sitemap.createMapper({ index: true }),
  ],
});

Authors

License

The MIT License

Copyright (c) 2012-2023 Jared Hanson <https://www.jaredhanson.me/>

kerouac-sitemap's People

Contributors

jaredhanson avatar qur2 avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

qur2 itsjw

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.