Skip to content

cheroliv/jbake-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

JBake Template with Tailwind CSS

This project provides a JBake template that uses Tailwind CSS instead of Bootstrap.

Installation

To use this template, follow these steps:

Install Java

JBake requires Java to be installed on your system. You can download the latest version of Java from the official website: https://www.oracle.com/java/technologies/javase-jdk11-downloads.html

Install JBake

You can download JBake from the official website: https://jbake.org/download.html

Windows

  1. Download the latest version of JBake from the official website.

  2. Extract the downloaded ZIP file to a directory of your choice, e.g., C:\JBake.

  3. Add the bin directory to your system’s PATH environment variable.

  4. Open a command prompt and verify the installation by running: + [source,bash] ---- jbake -v ----

Mac

  1. Download the latest version of JBake from the official website.

  2. Extract the downloaded ZIP file to a directory of your choice, e.g., /Applications/JBake.

  3. Add the bin directory to your system’s PATH environment variable.

  4. Open a terminal and verify the installation by running: + [source,bash] ---- jbake -v ----

Linux

  1. Download the latest version of JBake from the official website.

  2. Extract the downloaded ZIP file to a directory of your choice, e.g., /opt/jbake.

  3. Add the bin directory to your system’s PATH environment variable.

  4. Open a terminal and verify the installation by running: + [source,bash] ---- jbake -v ----

Create a New JBake Project

  1. Open a command prompt (Windows) or terminal (Mac/Linux).

  2. Navigate to the directory where you want to create your JBake project.

  3. Run the following command to create a new JBake project: + [source,bash] ---- jbake -i ----

Copy the Template Files

  1. Clone this repository or download the ZIP file and extract it.

  2. Copy the contents of the templates directory from this repository into the templates directory of your JBake project.

  3. The directory structure should look like this: + [source,text] ---- your-jbake-project/ ├── jbake.properties ├── content/ ├── output/ └── templates/ ├── layouts/ │ └── default.ftl ├── assets/ │ └── css/ │ └── tailwind.css └── index.ftl ----

Configure JBake to Use the New Template

  1. Open the jbake.properties file in your JBake project.

  2. Set the template.folder property to templates. + [source,properties] ---- template.folder=templates ----

Generate the Site

  1. Open a command prompt (Windows) or terminal (Mac/Linux).

  2. Navigate to the root directory of your JBake project.

  3. Run the following command to generate the site: + [source,bash] ---- jbake ----

Usage

The template includes the following:

  • Tailwind CSS for styling.

  • A basic layout (default.ftl) that includes the necessary Tailwind CSS setup.

  • An example index.ftl file to get you started.

To customize the template:

  • Modify the default.ftl file to change the overall layout.

  • Add or modify the CSS in assets/css/tailwind.css.

  • Create new content files in the content directory.

Customization

You can customize the template by modifying the following files:

  • templates/layouts/default.ftl: This file contains the main layout of the site.

  • templates/assets/css/tailwind.css: This file contains the Tailwind CSS styles.

  • templates/index.ftl: This is an example index page.

Contributing

If you have any suggestions or improvements, feel free to submit a pull request.

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published