{"id":20744610,"url":"https://github.com/npezza93/lecture","last_synced_at":"2026-04-18T16:36:51.234Z","repository":{"id":73219519,"uuid":"99458684","full_name":"npezza93/lecture","owner":"npezza93","description":"Write a slideshow for the terminal","archived":false,"fork":false,"pushed_at":"2017-08-26T20:23:08.000Z","size":247,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T12:51:32.005Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/npezza93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-06T02:10:15.000Z","updated_at":"2024-09-12T16:35:30.000Z","dependencies_parsed_at":"2023-09-19T11:01:04.874Z","dependency_job_id":null,"html_url":"https://github.com/npezza93/lecture","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/npezza93/lecture","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npezza93%2Flecture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npezza93%2Flecture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npezza93%2Flecture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npezza93%2Flecture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/npezza93","download_url":"https://codeload.github.com/npezza93/lecture/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npezza93%2Flecture/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31976794,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T16:27:12.723Z","status":"ssl_error","status_checked_at":"2026-04-18T16:27:11.140Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-17T07:16:21.612Z","updated_at":"2026-04-18T16:36:51.212Z","avatar_url":"https://github.com/npezza93.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lecture\n\nLecture is a way to present a slideshow through the terminal. All slides are written\nin Ruby. There is an example in the examples folder, found [here](https://github.com/npezza93/lecture/tree/master/examples).\n\n## Installation\n\n```bash\n  ❯ gem install lecture\n```\n\n## Usage\n\n```bash\n  ❯ lecture #{slides.rb}\n```\n\n### Configuration\n\nAt the top of your slides.rb file you can use the `configure` method to configure\nsettings within Lecture.\n\n```ruby\nconfigure do |lecture|\n  lecture.section_footer_text = \"───\"\nend\n```\n\nConfigurable settings include:\n- character_print_delay\n- transition_time\n- pygment_style\n- section_header_text\n- section_footer_text\n\n### Slide Types\n\nWhen writing your slides.rb file you have four slide types available.\n\n#### center\n\nA center slide centers every line on the screen horizontally and vertically.\n\n```ruby\n  center \u003c\u003c~SLIDE\n    Hello\n\n\n    This is a slide\n  SLIDE\n```\n\n![Center](https://raw.github.com/npezza93/lecture/master/screenshots/center.png)\n\n#### block\n\nA block slide preserves the text formatting, but centers the slide as a whole on the screen.\n\n\n```ruby\nblock \u003c\u003c~SLIDE\n  The lines in this block of text are\n  not centered\nSLIDE\n```\n\n![Block](https://raw.github.com/npezza93/lecture/master/screenshots/block.png)\n\n#### section\n\nA section slide has a title and draws a centered string of text above and below the title (default: \" § \").\nIt can be configured with the `section_header_text` and `section_footer_text` keys.\n\nSections allow you to group slides in your Ruby slide deck, and can yield to a block to promote slide organization.\n\n```ruby\nsection(\"This is a section\") do\n  center(\"This is a centered slide inside a section\")\nend\n```\n\n![Section](https://raw.github.com/npezza93/lecture/master/screenshots/section.png)\n\n#### code\n\nA code slide contains source code and has syntax highlighting.\n\nThe code method requires a second keyword argument with the name of the programming language.\n\nThe syntax highlighting style can be configured with the `pygment_style` key. Styles can be found [here](https://github.com/tmm1/pygments.rb), default is `paraiso-dark`.\n\n```ruby\ncode(%(\n  class PostsController \u003c ApplicationController\n    def index\n      @posts = Post.all\n    end\n  end\n), lexer: :ruby)\n```\n\n![Code](https://raw.github.com/npezza93/lecture/master/screenshots/code.png)\n\n### Keyboard Controls\n\n- \u003ckbd\u003eSPACE\u003c/kbd\u003e or \u003ckbd\u003e→\u003c/kbd\u003e go to the next slide\n- \u003ckbd\u003e←\u003c/kbd\u003e go to the previous slide\n- \u003ckbd\u003ea\u003c/kbd\u003e jumps to the first slide of the deck\n- \u003ckbd\u003ed\u003c/kbd\u003e jumps to the last slide of the deck\n- \u003ckbd\u003ej\u003c/kbd\u003e followed by a slide number(0 index) jumps to the given slide\n- \u003ckbd\u003ew\u003c/kbd\u003e redraws the slide\n- \u003ckbd\u003eq\u003c/kbd\u003e or \u003ckbd\u003eESC\u003c/kbd\u003e exits the slideshow\n\n### String Utilities\n\nYou have a variety of string colors and modes available when creating slides. To get a list of colors and modes you can use: `Lecture.available_colors` and `Lecture.available_modes`.\n\n```ruby\ncenter \u003c\u003c~SLIDE\n  #{'Slide'.bold}\n\n\n  This is a #{'slide'.green}\nSLIDE\n```\n\nYou can also use ANSI escape sequences and unicode characters to spice up your slides.\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/npezza93/lecture.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n---\n\nInspired by [fxn/tkn](https://github.com/fxn/tkn)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnpezza93%2Flecture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnpezza93%2Flecture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnpezza93%2Flecture/lists"}