JEKYLL(1)

📦
version 4.4.1 · 2 versions
  • 4.4.1 · debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 4.4.1 · fedora 43
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ JEKYLL(1) ✨

okay so bestie, welcome to jekyll — she's a blog-aware, static site generator 💖 and honestly? she's that girl. this is the User Commands manual page, and i'm gonna walk you through every single thing she does, no skips, no shortcuts. periodt.

🌸 USAGE 🌸

jekyll command [options...]

that's it. that's the whole vibe. a command, then whatever options you wanna sprinkle on top 🦋

🎀 COMMANDS 🎀

  • b, build — builds the site from its sources and drops the results into the destination directory. the classic. the moment. 🔥
  • clean — removes the destination directory. just… deletes it. gone. bye 💅
  • docs — shows you the docs, but plot twist: it requires the jekyll-docs plugin to be installed. no plugin, no docs, sorry bestie 😭
  • doctor, hyde — searches the site and prints out any specific deprecation or configuration issues it finds. think of it as a little check-up for your project 🩺✨
  • help [COMMAND] — shows the help message, and if you hand it a COMMAND it'll show help for that specific subcommand. so thoughtful 🫶
  • import — lets you import blog content from various resources as markdown files straight into the Jekyll ./_post/ and ./_drafts/ structure. requires the jekyll-import plugin to be installed. can't do it without her 🧚
  • new [PATH] — creates a brand new Jekyll site scaffold in PATH. fresh start energy 🌱
  • new-theme — creates a new Jekyll theme scaffold. theme girlies rise 👑
  • s, serve, server — serves the site locally. localhost era 💻💖
ngl, plugins like jekyll-compose can hand you even more commands than the ones documented here, so if you see a command we didn't list, that's why 👀

💅 OPTIONS 💅

there are some general flags to control Jekyll's behavior, and each command can be controlled further with additional options described in their respective manual pages. let's go through all of them, bestie, no cap:

  • -s, --source [DIR] — source directory, which defaults to ./. you can also set this in _config.yml via the source: option ✨
  • -d, --destination [DIR] — destination directory, defaults to ./_site. also settable in _config.yml via the destination: option 🎯
  • -p, --plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]] — plugins directory, defaults to ./_plugins. yes you can comma-stack a whole list of them 🔌
  • --safe — safe mode, defaults to false. this disables custom plugins and ignores links. also settable in _config.yml via the safe: option. lowkey the responsible choice 🛡️
  • --layouts DIR — layouts directory, defaults to ./_layouts 🖼️
  • --profile — generates a Liquid rendering profile. numbers, but make it fashion 📊
  • -h, --help — shows the help output. when in doubt 🫶
  • -v, --version — prints the name and version 👑
  • -t, --trace — shows the full backtrace when an error occurs. for when you need the whole story 😭

🦋 FILES 🦋

  • _config.yml — the main configuration is done by default in the file _config.yml. this file can control both Jekyll's behavior (see OPTIONS) and your site/theme configuration variables. if you wanna split the config, or use a non-default file, you can use the --config switch to define all the configuration files 📝✨

also, go read these, they're iconic:

🌈 ENVIRONMENT 🌈

  • JEKYLL_ENV — this environment variable defaults to development, and you can check it during a build via conditional statements to influence the output, for example. it usually only affects the build and serve commands. the other well-known value is production, but fr fr you can assign it literally any value you want 💜

more reading:

⭐ SEE ALSO ⭐

jekyll-b(1), jekyll-build(1), jekyll-clean(1), jekyll-docs(1), jekyll-doctor(1), jekyll-help(1), jekyll-hyde(1), jekyll-import(1), jekyll-new(1), jekyll-new-theme(1), jekyll-s(1), jekyll-serve(1), jekyll-server(1)

and there is extensive documentation at <https://jekyllrb.com/docs/> 📚💖

🫶 AUTHOR 🫶

this manual page was originally written by Youhei SASAKI <uwabami@gfd-dennou.org>, for the Debian GNU/Linux system (but may be used by others). it was later updated by Daniel Leidert <dleidert@debian.org>. absolute legends, we thank them for their service 🙇‍♀️✨

okay that's the whole page, bestie!! this was Jekyll 3.9, dated 2020-10-30 — go build something gorgeous with her, you've got this 💖🌸🦋💅

📦 where this page comes from