| commit | eb51f2c9e2424889ecb1b3a3d4279852c17fefe9 | [log] [tgz] |
|---|---|---|
| author | Chris Thistlethwaite <christ@apache.org> | Tue May 02 11:51:41 2023 -0400 |
| committer | Chris Thistlethwaite <christ@apache.org> | Tue May 02 11:51:41 2023 -0400 |
| tree | b9f4f5611f4e6bd58e6d0430523cb7ee64c294a5 | |
| parent | 458a66e12827483035690cd204e8a68f2de05c35 [diff] |
initial migration of blogs.a.o posts
Compatible with JBake 2.6.5
Future Imperfect is based on HTML5 UP's theme. Julio Pescador ported it for SSG websites. Here, it adapted for JBake.
Live example can be seen here.
First, make sure you install JBake as per instructions here.
Once you have JBake, assuming you are creating a site called ‘awesome-jbake’, in the terminal/command window run below commands -
>> mkdir awesome-jbake >> git clone https://github.com/manikmagar/jbake-future-imperfect-template.git awesome-jbake >> cd awesome-jbake && ls -ltr
You should see this repo files in there. Check JBake 2.5.1 Documentation to understand this structure.
To see in action, while in awesome-jbake folder, run jbake -b -s. In few seconds your site should be live on http://localhost:8820/, you can visit it in browser.
Everything in the template is driven by configuration parameters in jbake.properties file. Minimally required property set is already included, So keep all the properties in file and modify the values as needed.
JBake does support more than these properties and you can refer JBake Documentation.
Some tempalte features are described below.
Template does support adding Disqus comments to Posts. To enable it, just add your disqus shortname in jbake.properties -
site.disqus.shortname={yourdisqus}
Template allows you to capture Page Views. To enable it, just add your GA Tracking id in jbake.properties -
site.google.trackingid={ga.trackingid}
You can enable Estimated Reading time on your posts, by setting site.includeReadTiem=true in jbake.properties. This reading time is calculated using this reading time javascript library.
Site's top main menu can be controlled from jbake.properties -
site.menus.main = home, archive, about, rss #To add menus, for every menuitem in site.menus.main, add three properties in below pattern #site.menus.{menuitem}.home.label=Home #site.menus.{menuitem}.home.url=/ #site.menus.{menuitem}.home.icon=fa fa-home site.menus.main.home.label=Home site.menus.main.home.url=/ site.menus.main.home.icon=fa fa-home
You MUST define label, url and icon properties for each menu item in site.menus.main.
You can control your social links by adding your social handlers for sidebar.social.* propeties.
If you are hosting your static site on Github, then Github allows to set 404 error page. Content folder has a file called 404.html which is of type ‘page’ (i.e. it will be rendered by page template). You can modify this file content if neeeded but default included one also looks good :). This file must be at the root of content folder so that it gets rendered to root directory of your github pages. Rest will be take care by Github to show this file when user tries to non-existent url.
In the post metadata header, you can define below two properties to have a featured image for the post -
featuredimage=img/{path to image} featuredalt=alternate text for image
This template by default generates JSON feed. Following is the configuration related to this -
site.menus.main.rss.label=Subscribe ## change below url to feed.xml for tradional RSS Feed site.menus.main.rss.url=feed.json site.menus.main.rss.icon=fa fa-rss ## Commnet below two properties to generate, tradional XML RSS feed. feed.file=feed.json template.feed.file=feed-json.ftl
It is possible to have tradional XML RSS feed. Make the changes in jbake.properties, as suggested in comments above. Bake your site again.
Feel free to give a shout on twitter @manikmagar and @javabake
This theme is released under the MIT license. Please read the license for more information.
