{"id":16584820,"url":"https://github.com/limebeck/reveal-kt","last_synced_at":"2025-03-21T12:33:22.522Z","repository":{"id":77034882,"uuid":"560594315","full_name":"LimeBeck/reveal-kt","owner":"LimeBeck","description":"Kotlin wrapper for Reveal JS with CLI","archived":false,"fork":false,"pushed_at":"2024-09-03T22:03:15.000Z","size":2268,"stargazers_count":8,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T01:40:36.693Z","etag":null,"topics":["cli","kotlin","kotlin-script","kotlin-scripting","revealjs","slides"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","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/LimeBeck.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2022-11-01T20:52:02.000Z","updated_at":"2024-08-14T14:43:30.000Z","dependencies_parsed_at":"2023-12-07T19:27:37.817Z","dependency_job_id":"45708e93-8045-491b-a3cf-240fce328138","html_url":"https://github.com/LimeBeck/reveal-kt","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeBeck%2Freveal-kt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeBeck%2Freveal-kt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeBeck%2Freveal-kt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeBeck%2Freveal-kt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LimeBeck","download_url":"https://codeload.github.com/LimeBeck/reveal-kt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244799620,"owners_count":20512288,"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":["cli","kotlin","kotlin-script","kotlin-scripting","revealjs","slides"],"created_at":"2024-10-11T22:45:52.799Z","updated_at":"2025-03-21T12:33:22.112Z","avatar_url":"https://github.com/LimeBeck.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RevealKt\n\n[![CI](https://github.com/LimeBeck/reveal-kt/actions/workflows/main.yml/badge.svg)](https://github.com/LimeBeck/reveal-kt/actions/workflows/main.yml)\n![GitHub last commit](https://img.shields.io/github/last-commit/limebeck/reveal-kt)\n![GitHub](https://img.shields.io/github/license/limebeck/reveal-kt)\n[![Maven Central](https://img.shields.io/maven-central/v/dev.limebeck/revealkt-cli.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22dev.limebeck%22%20AND%20a:%22ko-te%22)\n\n\nKotlin DSL wrapper around Reveal JS presentation library\n\n## Usage\n\nRun server with presentation:\n```bash\njbang revealkt@limebeck.dev run ./MyAwesomePresentation.reveal.kts\n```\n\nBundle presentation to static html site:\n```bash\njbang revealkt@limebeck.dev bundle ./MyAwesomePresentation.reveal.kts\n```\n\nRender presentation to pdf via playwright:\n```bash\njbang revealkt@limebeck.dev pdf ./MyAwesomePresentation.reveal.kts -o myPresentation.pdf\n```\n\n\u003e [!CAUTION]\n\u003e For now playwright requires to download chromium first (uses npm)\n\nPlaywright documentation: https://playwright.dev/java/docs/browsers\n\n```bash\njbang revealkt@limebeck.dev chrome install\n```\n\nUninstall chrome \n```bash\njbang revealkt@limebeck.dev chrome uninstall\n```\n\n\nCreate new presentation from template\n```bash\njbang revealkt@limebeck.dev init my-awesome-presentation\ncd ./my-awesome-presentation\njbang revealkt@limebeck.dev run ./presentation/my-awesome-presentation.reveal.kts\n```\n\n## Add alias for `revealkt`\n\n```bash\njbang app install revealkt@limebeck.dev\nrevealkt run ./presentation/my-awesome-presentation.reveal.kts\n```\n\n## Example\n\n**MyAwesomeScript.reveal.kts**:\n```kotlin\nimport qrcode.color.Colors\n\ntitle = \"My awesome presentation\"\n\nconfiguration {\n    controls = false\n    progress = false\n}\n\nslides {\n    regularSlide {\n        autoanimate = true\n        +title { \"Hello from my awesome presentation\" }\n    }\n    regularSlide {\n        autoanimate = true\n        +qrCode(\"https://github.com/LimeBeck/reveal-kt\") {\n            stretch = true\n            transformBuilder {\n                val logo = loadAsset(\"logo2.png\")\n                it.withSize(20).withColor(Colors.css(\"#B125EA\")).withLogo(logo, 150, 150, clearLogoArea = true)\n            }\n        }\n    }\n    verticalSlide {\n        val title = Title { \"Some text\" }\n        slide {\n            autoanimate = true\n            +title\n            +note {\n                \"Some note\"\n            }\n        }\n        slide {\n            autoanimate = true\n            +title\n            +title { \"Updated text\" }\n            +note {\n                \"Some note\"\n            }\n        }\n        slide {\n            autoanimate = true\n            +title\n            +code {\n                //language=JSON\n                \"\"\"\n                   {\n                    \"string\": \"some string\"\n                   } \n                \"\"\".trimIndent()\n            }\n        }\n        slide {\n            +img(src = \"image.png\") {\n                stretch = true\n            }\n        }\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimebeck%2Freveal-kt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flimebeck%2Freveal-kt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimebeck%2Freveal-kt/lists"}