https://github.com/docpad/docpad-plugin-dateurls
DocPad plugin that adds support for date based URLs to DocPad
https://github.com/docpad/docpad-plugin-dateurls
docpad-plugin
Last synced: 12 months ago
JSON representation
DocPad plugin that adds support for date based URLs to DocPad
- Host: GitHub
- URL: https://github.com/docpad/docpad-plugin-dateurls
- Owner: docpad
- License: other
- Created: 2013-04-21T02:31:22.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2024-01-28T00:55:15.000Z (over 2 years ago)
- Last Synced: 2025-06-10T11:48:42.497Z (about 1 year ago)
- Topics: docpad-plugin
- Language: JavaScript
- Homepage:
- Size: 335 KB
- Stars: 4
- Watchers: 13
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- Changelog: history.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: license.md
Awesome Lists containing this project
README
docpad-plugin-dateurls
DocPad plugin which adds the ability to use the date within posts to add url routes /YEAR/MONTH/DAY.
Install
Install this DocPad plugin by entering docpad install dateurls into your terminal.
## Usage
The purpose of this plugin is to enable date based url paths based on the a date metadata field within a post.
Add a date yaml header to posts you would like to have a date based url
For /documents/posts/2012-10-21-my-blog-post.html.md
```
---
name: my blog post
date: 2012-10-21
---
```
results:
```
http://yoursite.com/2012/10/21/my-blog-post.html
```
### Document Paths
By default dateurls will pickup documents within /documents/posts if you would like to process a different folder under documents add:
```coffee
plugins:
dateurls:
documentPath: 'yourpath'
```
### Clean Urls
By default the files paths will have the file extension:
```
http://yoursite.com/2012/10/21/my-blog-post.html
```
If you would like to have clean urls such as:
```
http://yoursite.com/2012/10/21/my-blog-post
```
Pass true to the cleanurl configuration property
```coffee
plugins:
dateurls:
cleanurl: true
```
### Trailing Slashes
When using clean urls a route will be added with the forms
```
http://yoursite.com/2012/10/21/my-blog-post
http://yoursite.com/2012/10/21/my-blog-post/
```
If you wish to have links to the post use a trailing slash pass true to the trailingSlashes configuration property
```coffee
plugins:
dateurls:
trailingSlashes: true
```
### Collection Name
If you would like dateurls to process documents in a collection you defined yourself (instead of documents in a specific document path), you can tell the plugin which collection to use explicitly:
```coffee
plugins:
dateurls:
collectionName: 'myCollection'
```
### Date Format
If you wish to format the date portion of the generated URL differently, you can tell the plugin which date format to use with moment explicitly:
```coffee
plugins:
dateurls:
dateFormat: '/YYYY/MM'
```
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?
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:
- Copyright © Mark Groves
and licensed under: