render-engine-theme-kjaymiller 2024.11.1

This is a theme based on the design of kjaymiller.com at the time

KJayMiller Render Engine Theme

This is a theme based on the early development of render-engine for kjaymiller.com.

It relies on Tailwind CSS with support for icons via fontawesome and embeds for analytics, and newsletters.

Quickstart

1. Install this theme through pip:

pip install render-engine-theme-kjaymiller

2. Import and register your theme:

from render_engine import Site
from render_engine_theme_kjaymiller import kjaymiller

app = Site()
app.register_themes(kjaymiller)

3. Add configuration file

This theme supports styling through TailwindCSS. To add your own configuration, create a tailwind.config.js file in your project root and add your configuration there. You will need the following information in your config:

// tailwind.config.js
/** @type {import('tailwindcss').Config} */
module.exports = {
  content: ['output/**/*.{html, js}'],
  plugins: [require('@tailwindcss/typography')]
}

4. Add your theme settings

This theme supports embeds for many different tools as well as configurations for your tailwindcss settings in your app.py module. Here is a basic example of what your site's theme settings might look like:

app = Site()

settings = {
    "NAVIGATION": {...} ,
    ... # settings for other plugins and your site
    "theme" : {
      ... # Your theme settings
        "colors": {
          "main1": "rose-800", # You can use any valid tailwindcss color here
        }
        "favicon": "https:fav.farm/☕", # url to your favicon
        "colors": {
            "main1": "purple-500",
            "header_gradient_interval": 100,
        },
        "social": {
            "youtube": "https://www.youtube.com/kjaymiller",
            "twitter": "https://twitter.com/kjaymiller",
            "linkedin": "https://linkedin.com/in/kjaymiller",
            "github": "https://github.com/kjaymiller",
            "mastodon": "https://mastodon.social/@kjaymiller",
        },
    }
}

# Update your settings: prefer update to overwrite
app.site_settings.update(theme)

5. Build your site

python -m render_engine serve --build app:app