Skip to content

This vscode extension can simply Run your Jekyll site locally and opens your site in browser

License

Notifications You must be signed in to change notification settings

Kanna727/jekyll-run

Repository files navigation

Visual Studio Marketplace Version Visual Studio Marketplace Downloads Visual Studio Marketplace Rating GitHub Workflow Status GitHub

Looking for Donations & Contributors

I'm unable to actively develop & improve this extension to support macbook, github codespaces etc.. You can sponsor or contribute to make this extension more feature rich

VSCode Extension to Build & Run Jekyll Static Websites Locally

This extension can simply Run your Jekyll site locally and opens your site in browser

Features

If a Jekyll Workspace is open:

  • You can run following commands from Command Palette/Keybindings:

    Command Shortcut Functionality
    Jekyll Run (ctrl+F5) Builds Project, Starts Jekyll Server & Opens the local hosted site in Browser
    Jekyll Stop (ctrl+F6) Stops Jekyll Server
    Jekyll Restart (ctrl+F7) Restarts Jekyll Server
    Jekyll Build (ctrl+F8) Builds Project
    Jekyll Open in Browser (ctrl+F9) Opens the local hosted site in Browser while Jekyll Server is running

    All the above shortcuts are also configurable via vscode keyboard shortcuts editor

  • Status Bar shortcuts:

    • Jekyll Run

    • Jekyll Stop/Restart/Open in Browser

  • Editor Title Menus:

    • Jekyll Run

    • Jekyll Stop/Restart

Configuration

Following fields in the extension's settings page are configurable:

  • jekyll-run.commandLineArguments: Command Line Arguments to be passed to bundle exec jekyll serve cmd. Defaults to empty string i.e, no arguments

Requirements

  • Static Website Workspace in VSCode i.e, _config.yml should be present in the opened workspace
  • Jekyll