Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docpad/docpad-plugin-tags

Generate tag pages with DocPad
https://github.com/docpad/docpad-plugin-tags

docpad-plugin

Last synced: 2 months ago
JSON representation

Generate tag pages with DocPad

Host: GitHub
URL: https://github.com/docpad/docpad-plugin-tags
Owner: docpad
License: other
Created: 2013-07-18T19:00:13.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2023-12-31T01:56:19.000Z (about 1 year ago)
Last Synced: 2024-04-07T00:54:32.092Z (9 months ago)
Topics: docpad-plugin
Language: CoffeeScript
Homepage:
Size: 193 KB
Stars: 9
Watchers: 15
Forks: 5
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

Tags Plugin for DocPad

Create tag pages within DocPad

## Configuration

### Customising the Output

The default directory for where the imported documents will go inside is the `tags` directory. You can customise this using the `relativeDirPath` plugin configuration option.

The default extension for imported documents is `.json`. You can customise this with the `extension` plugin configuration option.

The default content for the imported documents is the serialised tag data as JSON data. You can can customise this with the `injectDocumentHelper` plugin configuration option which is a function that takes in a single [Document Model](https://github.com/bevry/docpad/blob/master/src/lib/models/document.coffee).

If you would like to render a partial for the imported document, add a layout, and change the extension, you can this with the following plugin configuration:

``` coffee
extension: '.html.eco'
injectDocumentHelper: (document) ->
document.setMeta(
layout: 'default'
data: """
<%- @partial('content/tag', @) %>
"""
)
```

You can find a great example of this customisation within the [syte skeleton](https://github.com/docpad/syte.docpad) which combines the tags plugin with the [partials plugin](http://docpad.org/plugin/partials) as well as the [tumblr plugin](http://docpad.org/plugin/tumblr) and [paged plugin](http://docpad.org/plugin/paged).

### Creating a File Listing

As imported documents are just like normal documents, you can also list them just as you would other documents. Here is an example of a `index.html.eco` file that would output the titles and links to all the imported tag documents:

``` erb