0.3.0 • Published 1 month ago

kerouac-cname v0.3.0

Weekly downloads
1
License
MIT
Repository
github
Last release
1 month ago

kerouac-cname

Kerouac middleware that generates a CNAME file for use with GitHub Pages.

Status: Version Build Quality Coverage Dependencies

Sponsorship

Kerouac is open source software. Ongoing development is made possible by generous contributions from individuals and corporations. To learn more about how you can help keep this project financially sustainable, please visit Jared Hanson's page on Patreon.

Install

$ npm install kerouac-cname

Usage

First, set the base url setting for your site.

site.set('base url', 'http://www.example.com/');

Then declare a CNAME page, using this middleware.

site.page('/CNAME', require('kerouac-cname')());

The generated output will include a /CNAME resource, containing your site's hostname. This can be used when hosting your site with GitHub Pages and using a custom domain.

License

The MIT License

Copyright (c) 2017-2018 Jared Hanson [http://jaredhanson.net/](http://jaredhanson.net/)