Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

Shotify

Take beautiful screenshots of code.

Example screenshot

Status

Implemented:

  • @shotify/core - Core screenshot generation (HTML/PNG rendering)
  • @shotify/cli - Command-line interface
  • ✅ Emacs integration
  • ✅ VS Code extension
  • ✅ Neovim plugin

Planned:

  • ⏳ Zed editor integration

Installation

Install from npm

CLI Tool (Recommended):

npm install -g @shotify/cli

Core Library (for Node.js projects):

npm install @shotify/core

Verify installation:

shotify --version

Install from Source

For development or contributing:

  1. Prerequisites:

    • Node.js 16 or higher
    • pnpm 10.18+ (install via npm install -g pnpm)
  2. Clone and build:

    git clone https://github.com/amackera/shotify.git
    cd shotify
    pnpm install
    pnpm build
  3. Link CLI globally:

    cd packages/cli
    pnpm link --global

Usage

Core Package

import{renderHtml,renderPng}from'@shotify/core';// Generate HTMLconsthtml=awaitrenderHtml(code,{lang: 'typescript',theme: 'github-dark',title: 'example.ts',showLineNumbers: true,});// Generate PNGconst{ outPath }=awaitrenderPng(code,{lang: 'typescript',theme: 'github-dark',out: './screenshot.png',});

CLI

# Screenshot a file
shotify example.ts -o screenshot.png
# From stdinecho"console.log('hello')"| shotify --lang js
# Custom options
shotify code.py --theme github-light --title "My Script" --width 1000

Options:

  • -l, --lang <language> - Programming language (default: typescript)
  • -t, --theme <theme> - Color theme (default: github-dark)
  • --title <title> - Title bar text
  • --line-numbers/--no-line-numbers - Toggle line numbers
  • --start-line <number> - Starting line number
  • -w, --width <pixels> - Screenshot width (default: 800)
  • -p, --padding <value> - Padding (default: 2rem)
  • -b, --background <color> - Background color (default: #1e1e1e)
  • -o, --out <path> - Output file path

VS Code

Installation:

  1. Build the extension:

    cd adapters/vscode
    pnpm install
    pnpm run build
  2. Install the extension in VS Code:

    • Option A: Run pnpm run package to create a .vsix file, then install via VS Code's "Install from VSIX" command
    • Option B: Open the adapters/vscode folder in VS Code and press F5 to launch in development mode

Usage:

Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and search for:

  • Shotify: Screenshot Selection - Screenshot selected code and save to file
  • Shotify: Screenshot File - Screenshot entire file and save to file
  • Shotify: Screenshot Selection to Clipboard - Screenshot selected code and copy to clipboard
  • Shotify: Screenshot File to Clipboard - Screenshot entire file and copy to clipboard

Configuration:

{
"shotify.theme": "github-dark",
"shotify.width": 800,
"shotify.showLineNumbers": true,
"shotify.outputDirectory": "~/Screenshots",
"shotify.padding": "2rem",
"shotify.background": "#1e1e1e"
}

See adapters/vscode/README.md for more details.

Emacs

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Emacs config (~/.emacs.d/init.el or ~/.emacs):

    (add-to-list'load-path"/path/to/shotify/adapters/emacs")
    (require'shotify)
    ;; Optional: bind to a key
    (global-set-key (kbd"C-c s") 'shotify-screenshot)
  3. Restart Emacs or evaluate the configuration

Usage:

  • M-x shotify-screenshot - Screenshot selected region
  • M-x shotify-screenshot-buffer - Screenshot entire buffer

Configuration:

;; Path to shotify CLI (default: "shotify")
(setq shotify-cli-path "/custom/path/to/shotify")
;; Theme (default: "github-dark")
(setq shotify-theme "github-light")
;; Screenshot width in pixels (default: 800)
(setq shotify-width 1000)
;; Show line numbers (default: t)
(setq shotify-show-line-numbers nil)
;; Output directory (default: "~/Screenshots")
(setq shotify-output-directory "~/Pictures/Code")

See adapters/emacs/README.md for more details.

Neovim

Installation:

  1. Ensure shotify CLI is installed (see Installation section above)

  2. Add to your Neovim config using your preferred plugin manager:

    Using lazy.nvim:

    {
    dir='/path/to/shotify/adapters/nvim',
    name='shotify',
    config=function()
    require('shotify').setup({
    theme='github-dark',
    width=800,
    show_line_numbers=true,
    output_directory='~/Screenshots',
    })
    end,
    }

    Using packer.nvim:

    use {
    '/path/to/shotify/adapters/nvim',
    as='shotify',
    config=function()
    require('shotify').setup()
    end
    }
  3. Restart Neovim or reload your configuration

Usage:

Commands:

  • :ShotifySelection - Screenshot selected code (use in visual mode)
  • :ShotifyFile - Screenshot entire file
  • :ShotifySelectionToClipboard - Screenshot selection and copy to clipboard
  • :ShotifyFileToClipboard - Screenshot entire file and copy to clipboard

Keybindings (optional):

-- Add to your config for convenient shortcutsvim.keymap.set('v', '<leader>ss', ':ShotifySelection<CR>', { desc='Screenshot selection' })
vim.keymap.set('n', '<leader>sf', ':ShotifyFile<CR>', { desc='Screenshot file' })
vim.keymap.set('v', '<leader>sc', ':ShotifySelectionToClipboard<CR>', { desc='Screenshot to clipboard' })

Configuration:

require('shotify').setup({
cli_path='shotify', -- Path to shotify CLItheme='github-dark', -- Color themewidth=800, -- Screenshot width in pixelsshow_line_numbers=true, -- Show line numberspadding='2rem', -- Padding around codebackground='#1e1e1e', -- Background colorscale=2, -- Resolution scale (1=normal, 2=retina, 3=ultra)output_directory='~/Screenshots', -- Where to save screenshots
})

Platform Notes:

  • macOS: Clipboard support works out of the box
  • Linux: Requires xclip for clipboard functionality (sudo apt-get install xclip)
  • Windows: Clipboard support uses PowerShell (built-in)

See adapters/nvim/README.md for more details.

Available Themes

Shotify uses Shiki for syntax highlighting, providing access to 55 beautiful bundled themes. You can configure the theme via:

  • CLI: --theme <name> flag
  • VS Code: shotify.theme setting
  • Emacs: shotify-theme variable
  • Neovim: theme option in require('shotify').setup()
  • Core API: theme option in renderHtml() or renderPng()

Popular Themes:

  • github-dark (default) - GitHub's dark theme
  • github-light - GitHub's light theme
  • dracula - The popular Dracula theme
  • monokai - Classic Monokai
  • nord - Arctic, north-bluish color palette
  • tokyo-night - Clean, dark theme
  • material-theme - Material Design inspired
  • one-dark-pro - Atom's iconic One Dark theme

All Dark Themes:andromeeda, aurora-x, ayu-dark, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dark-plus, dracula, dracula-soft, everforest-dark, github-dark, github-dark-default, github-dark-dimmed, github-dark-high-contrast, houston, kanagawa-dragon, kanagawa-wave, laserwave, material-theme, material-theme-darker, material-theme-ocean, material-theme-palenight, min-dark, monokai, night-owl, nord, one-dark-pro, plastic, poimandres, red, rose-pine, rose-pine-moon, slack-dark, solarized-dark, synthwave-84, tokyo-night, vesper, vitesse-black, vitesse-dark

All Light Themes:catppuccin-latte, everforest-light, github-light, github-light-default, github-light-high-contrast, kanagawa-lotus, light-plus, material-theme-lighter, min-light, one-light, rose-pine-dawn, slack-ochin, snazzy-light, solarized-light, vitesse-light

Preview Themes: Visit shiki.style/themes to preview all themes with live code examples.

Development

# Build all packages
pnpm build
# Watch mode
pnpm dev
# Test core packagecd packages/core && pnpm test

About

Showcase your code with beautiful screenshots and embedded HTML

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages