{"id":14982878,"url":"https://github.com/idadzie/zsh-presenter-mode","last_synced_at":"2025-06-18T03:06:11.823Z","repository":{"id":110168923,"uuid":"196653979","full_name":"idadzie/zsh-presenter-mode","owner":"idadzie","description":" :mega: Expand your aliases during presentations","archived":false,"fork":false,"pushed_at":"2023-03-03T13:40:38.000Z","size":17,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-09T10:34:45.206Z","etag":null,"topics":["alias","aliases","presentations","terminal","zinit","zsh","zsh-plugin","zshell"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/idadzie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-07-12T22:40:32.000Z","updated_at":"2023-06-28T01:37:07.000Z","dependencies_parsed_at":"2023-03-13T13:57:30.054Z","dependency_job_id":null,"html_url":"https://github.com/idadzie/zsh-presenter-mode","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/idadzie/zsh-presenter-mode","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idadzie%2Fzsh-presenter-mode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idadzie%2Fzsh-presenter-mode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idadzie%2Fzsh-presenter-mode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idadzie%2Fzsh-presenter-mode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/idadzie","download_url":"https://codeload.github.com/idadzie/zsh-presenter-mode/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idadzie%2Fzsh-presenter-mode/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260477922,"owners_count":23015064,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alias","aliases","presentations","terminal","zinit","zsh","zsh-plugin","zshell"],"created_at":"2024-09-24T14:06:20.746Z","updated_at":"2025-06-18T03:06:06.810Z","avatar_url":"https://github.com/idadzie.png","language":"Shell","funding_links":[],"categories":["Plugins"],"sub_categories":["ZSH on Windows","Zinit (née zplugin)"],"readme":"# zsh-presenter-mode\n\n[![Maintenance][maintenance badge]]()\n\nZsh plugin to expand aliases during presentations.\n\nIt also increases the terminal window's contrast to enhance visibility. :wink:\n\n\n## :floppy_disk: Installation\n\n### Using [Zinit][zinit]\n\nAdd the snippet below to your **.zshrc** file.\n\n```zsh\nzinit ice wait'0' lucid\nzinit light idadzie/zsh-presenter-mode\n\n# or using the for syntax.\nzinit light-mode for idadzie/zsh-presenter-mode\n```\n\n### Manual\n\nClone this repository and source the **zsh-presenter-mode.plugin.zsh** file in your **.zshrc** file.\n\n```zsh\n# Clone this repository.\ngit clone https://github.com/idadzie/zsh-presenter-mode.git $XDG_DATA_HOME/zsh-presenter-mode\n\n# Append to your .zshrc file.\necho \"source $XDG_DATA_HOME/zsh-presenter-mode/zsh-presenter-mode.plugin.zsh\" | tee -a \"${ZDOTDIR:-$HOME}/.zshrc\"\n```\n\n\n## :rocket: How to use\nIn any terminal window, use the key binding \u003ckbd\u003eCtrl  P\u003c/kbd\u003e,\u003ckbd\u003eCtrl  M\u003c/kbd\u003e or the alias `presenter-toggle` to quickly switch between modes.\n\n\n## :wrench: Customisation\n\nYou can change the default key binding by adding the snippet below to your **.zshrc**.\n\n```zsh\nbindkey '\\e\\e' toggle-presenter-mode\n```\n\nTo not pollute the global namespace, there's a single **$PRESENTER_MODE** hash you can add to your **.zshrc** to customise the default parameters before loading this plugin.\n\n| Hash Field                         | Description                                                  |\n| ---------------------------------- | ------------------------------------------------------------ |\n| PRESENTER_MODE[BANNER_SHOW]        | Show banner text when presentation mode is activated. Default: `1` |\n| PRESENTER_MODE[SHOW_PREEXEC_ARRAY] | Show preexec array when presentation mode is toggled. Default: `0` |\n| PRESENTER_MODE[BANNER_TEXT]        | Banner text when presentation mode is activated. Default: `PRESENTATION MODE` |\n| PRESENTER_MODE[BG_DEFAULT]         | Background colour to set after presentation mode is deactivated. Default: `#282828` |\n\n### Example\n\n```\ndeclare -A PRESENTER_MODE\nPRESENTER_MODE[BANNER_TEXT]='Welcome to My TED Talk!'\nPRESENTER_MODE[BG_DEFAULT]='#2c2c2c'\nPRESENTER_MODE[SHOW_PREEXEC_ARRAY]=1\n\n# Load the plugin below.\n...\n```\n\n\n## :handshake: Credit\n\nThe main [presenter_mode_{start,stop}][presenter-mode] functions were borrowed from [robobenklein's][robo] amazing [dotfiles][dotfiles].\n\n\n## :sparkling_heart: Like this project ?\n\nLeave a :star: If you think this project is cool.\n\n[maintenance badge]: https://img.shields.io/maintenance/yes/2023.svg\n[zinit]: https://github.com/zdharma-continuum/zinit\n[robo]: https://github.com/robobenklein\n[dotfiles]: https://github.com/robobenklein/configs\n[presenter-mode]: https://github.com/robobenklein/configs/blob/master/zsh/plunks/presenter-mode.zsh\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidadzie%2Fzsh-presenter-mode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fidadzie%2Fzsh-presenter-mode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidadzie%2Fzsh-presenter-mode/lists"}