{"id":13426784,"url":"https://github.com/docwhat/magic_reveal","last_synced_at":"2025-04-06T18:32:47.389Z","repository":{"id":9162262,"uuid":"10958701","full_name":"docwhat/magic_reveal","owner":"docwhat","description":"Create presentations with markdown and ease!","archived":false,"fork":false,"pushed_at":"2021-02-13T02:10:41.000Z","size":412,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-22T04:41:28.371Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docwhat.github.io/magic_reveal/","language":"JavaScript","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/docwhat.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}},"created_at":"2013-06-26T04:57:50.000Z","updated_at":"2014-03-05T04:11:14.000Z","dependencies_parsed_at":"2022-08-25T20:41:53.287Z","dependency_job_id":null,"html_url":"https://github.com/docwhat/magic_reveal","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docwhat%2Fmagic_reveal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docwhat%2Fmagic_reveal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docwhat%2Fmagic_reveal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docwhat%2Fmagic_reveal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docwhat","download_url":"https://codeload.github.com/docwhat/magic_reveal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247531428,"owners_count":20953962,"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":[],"created_at":"2024-07-31T00:01:44.507Z","updated_at":"2025-04-06T18:32:46.654Z","avatar_url":"https://github.com/docwhat.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Magic Reveal\n\nMagic Reveal makes creating presentations easy and fun.\n\nSee it in action at the [demo/tutorial](http://docwhat.github.io/magic_reveal/)\n\n[![Gem Version](https://badge.fury.io/rb/magic_reveal.png)](http://badge.fury.io/rb/magic_reveal)\n[![Build Status](https://secure.travis-ci.org/docwhat/magic_reveal.png?branch=master)](http://travis-ci.org/docwhat/magic_reveal)\n[![Dependencies](https://gemnasium.com/docwhat/magic_reveal.png?branch=master)](https://gemnasium.com/docwhat/magic_reveal)\n[![Coverage Status](https://coveralls.io/repos/docwhat/magic_reveal/badge.png?branch=master)](https://coveralls.io/r/docwhat/magic_reveal)\n[![Code Climate](https://codeclimate.com/github/docwhat/magic_reveal.png)](https://codeclimate.com/github/docwhat/magic_reveal)\n\n## Installation\n\nUse `gem` to install magic_reveal:\n\n    $ gem install magic_reveal\n\nThe version numbers are the based on the versions of\n[reveal.js](https://github.com/hakimel/reveal.js). The last number is\nthe revision specific to Magic Reveal.\n\n### Requirements\n\n* Ruby 1.9.3 or newer\n* A recent version of [Bundler](http://bundler.io/)\n\n\u003cbr/\u003e\nMagic Reveal *may* work on non-posix systems, but I make no promises. Pull Requests are\nwelcome.\n\n## Usage\n\nTo get started:\n\n    $ magic-reveal new my-presentation\n    $ cd my-presentation\n    $ vim slides.md\n\nFeel free to replace [vim](http://vim.org/) with the editor of your choice.\n\n### Viewing the presentation\n\n    $ magic-reveal start\n\nThen open your browser to [`http://localhost:9292`](http://localhost:9292).\n\n### Write a static index.html\n\n    $ magic-reveal static\n\nThis generates a static `index.html` suitable for committing to git.\n\n### The format of slides.md\n\nMagic Reveal uses [github-flavored\nmarkdown](https://help.github.com/articles/github-flavored-markdown)\nas much as practical.\n\n#### External code files\n\nIf you want your source code to be in files outside your `slides.md`, no problem!\n\nTo load source from `example.rb`, for example, then use `@@source = \u003cfilename\u003e`\nas the body of the code section.\n\nFor example:\n\n```\n`@@source = example.rb`\n```\n\nThis works with triple back-quote blocks and four-space indented blocks sections as well.\n\n## Development\n\nThere is a full [RSpec](http://rspec.info/) test suite.  Make sure you\nwrite tests before you continue.\n\nFor the places where I don't have tests because I couldn't figure it out,\nplease help!\n\n### Future plans\n\n* Generate static sites via the `magic-reveal` command line tool\n* A configuration file, for using plugins, etc.\n\n## Contributing\n\n(because you know it could be better)\n\n1. [Fork it](https://github.com/docwhat/magic_reveal)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocwhat%2Fmagic_reveal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocwhat%2Fmagic_reveal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocwhat%2Fmagic_reveal/lists"}