rizqijune / PNYA-Bludit-Theme

A theme for bludit cms. Made with gulp and tailwindcss. Easy to develop and launch. This is just and experiment with gulp and tailwindcss.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PNYA - A Tailwind Bludit Theme

Made with Gulp with TailwindCSS v3 Starter Kit with some modification and package update. Still working in progress.

Features

  • Easy configuration using config.js
  • Live reload on file/assets changes using browser-sync
  • SCSS support
  • Alpine.JS (Hardcode)
  • Dark Mode support
  • Minification of styles and scripts on production build
  • Minification of images on production build using imagemin
  • Includes following tailwindcss plugins (can be disabled/enabled with config.js)

Quick Start

You can get started by clicking on Use this template for creating new repo using this template or simply by cloning it.

  • Build with Volta Node manager
  • Node@21.5.0
  • Yarn@4.0.2

You can use pnpm instead of yarn. npm is not recomended.

Install dev dependencies

yarn // or pnpm install

Start development server with live preview

yarn dev // or pnpm dev

Generate build files for production server

yarn build // or pnpm build

All dev files are present in dev folder. The build version can be found in build folder after running yarn build command.

Configuration

All configurations are found in config.js file in the root directory. You can configure browser default port, enable/disable plugins by simply updating boolean values (Default is set to true) and many more.

const config = {
  tailwindjs: "./tailwind.config.js",
  port: 9050, // default port
  // purgecss options
  purgecss: {
    content: ["src/**/*.{html,js,php}"],
    ...
  },
  // imagemin options for image optimizations
  imagemin: {
    png: [0.7, 0.7], // range between min (0) and max (1) as quality - 70% with current values for png images,
    jpeg: 70, // % of compression for jpg, jpeg images
  },
};

// tailwind plugins
const plugins = {
  typography: true, // set to false to disable
  forms: true,
  containerQueries: true,
};
...

Todo

  • Live Preview
  • Auto copy build to bl-theme
  • Remove comment in prod
  • Make it more responsive
  • Easy personalized with config
  • All in one command
  • Use API instead of manual insert php code

Made with

License

This project is open source and available under the MIT License.

About

A theme for bludit cms. Made with gulp and tailwindcss. Easy to develop and launch. This is just and experiment with gulp and tailwindcss.


Languages

Language:PHP 69.9%Language:JavaScript 21.2%Language:SCSS 6.2%Language:Hack 2.7%