JBake Permalinks #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pull bot
pushed a commit
that referenced
this pull request
Jan 3, 2022
This change allows to override JBake properties or define custom
properties which can be used in the templates, e.g.:
<plugin>
<groupId>br.com.ingenieux</groupId>
<artifactId>jbake-maven-plugin</artifactId>
<executions>
...
</executions>
<configuration>
<properties>
<!-- override jbake property -->
<render.feed>true</render.feed>
<!-- define custom property -->
<foo>bar</foo>
</properties>
</configuration>
</plugin>
To make this possible an update to JBake 2.4.0 was necessary.
This fixes #3 and resolves #11.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
jbake-org#294
This pull request implements Permalink/URI Generation and customization in JBake.
It is driven by a property
permalinkin jbake.properties file. Sample permalink pattern can bepermalink=/:blog:/:titlewhich will generate urls asblog\first-post.html.If
permalinkis not specified then default pattern is/:filepath.Every keyword should be separated with '/:'. It allows you to use any keywords from content header. eg.
/:slug/:tags/:title.Few Rules:
Some keywords are reserved for specific format. Below is the list of such keywords -
/:filepath: This keyword will result it addition of relative source file path fromcontentfolder. If you want to maintain the content folder structure in output then,permalink=/:filepathwill result in generating URI structure same as source files./:filename: This keyword will result in addition of source file name (without extension)./:YEAR,/:MONTH,:DAY: These keywords will add a related date part from content published date to url.permalink=/:blog:/:filenamewill result in generation of urls like /blog/First-post.htmlUsing permalink in templates
Generated permalinks can be accessed in templates as
content.permalink.Extension-less permalinks
If
ur.noExtensionis set totruethen all permalinks will be extension-less. For example,permalink=/:blog:/:filenamewill generate/blog/First-post/.How to use different permalink patterns for each content type.
It is possible to use different permalink patterns based on content type. For example, post and page content type can use their own permalink patterns.
permalinkproperty will always be used as a default pattern for every content. To customize it based on content type, you can add another propertypermalink.{type}and specify pattern for it.Sample configuration -
permalink=/:filepathpermalink.post=/:blog:/:filenamepermalink.page=/:filenameAbove configuration will result in pages with uri as filenames only, while posts will have suffix /blog/ for url. Any other content type will keep using
/:filepathpattern.