{"id":18026411,"url":"https://github.com/benziahamed/playme","last_synced_at":"2026-04-19T15:02:19.622Z","repository":{"id":149486056,"uuid":"84597866","full_name":"BenziAhamed/playme","owner":"BenziAhamed","description":"Convert Swift Playgrounds to Markdown","archived":false,"fork":false,"pushed_at":"2017-03-21T17:09:59.000Z","size":57,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-10T04:28:24.198Z","etag":null,"topics":["command-line-tool","markdown","playgrounds","swift-3","swift3","tool","utility"],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BenziAhamed.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-10T20:24:03.000Z","updated_at":"2018-01-05T22:21:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"d2822f3f-fccd-49bf-98e8-a374ec41f4de","html_url":"https://github.com/BenziAhamed/playme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenziAhamed%2Fplayme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenziAhamed%2Fplayme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenziAhamed%2Fplayme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenziAhamed%2Fplayme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BenziAhamed","download_url":"https://codeload.github.com/BenziAhamed/playme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247235213,"owners_count":20905911,"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":["command-line-tool","markdown","playgrounds","swift-3","swift3","tool","utility"],"created_at":"2024-10-30T08:06:38.144Z","updated_at":"2026-04-19T15:02:14.580Z","avatar_url":"https://github.com/BenziAhamed.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# playme\nConvert Swift Playgrounds to Markdown\n\n## Example\n\nThis [readme](https://github.com/BenziAhamed/Tracery) was generated using playme.\n\n## Installation\n\nClone this repo or just download the playme.swift file.\n\nIn a terminal type:\n\n```sh\nchmod +x playme.swift\n./playme.swift path_to_your_playground\n```\n\nAlternatively\n\n```sh\nswift playme.swift path_to_your_playground\n```\n\nplayme will print converted markdown to the terminal. Redirect its output to a file of your choice. E.g.\n\n```sh\n./playme.swift path_to_your_playground \u003e README.md\n```\n\n## Usage\n\n```\nusage: playme path_to_playground [--toc [--toc-top]] [--no-credits] [update [--check]]\n\n--toc          generate a GitHub compatible TOC at the beginning of the document\n--toc-top      generate back to top links before relevant headers\n--no-credits   prevent appending credits text at the end\n\nupdate         updates playme to the latest version\n--check        run update availability checks, but does not update\n\n--help         prints usage\n\nvisit https://github.com/BenziAhamed/playme\n```\n\n## Features\n\n### Table of Contents generation\nYou can pass in `--toc` to generate a table of contents compatible with GitHub.\n\n```sh\n./playme.swift path_to_your_playground --toc\n```\n\nThe table of contents will be generated, by default, at the beginning.\n\nIf you wish to control more precisely where the TOC should be created, add `{{GEN:TOC}}` a line in a _markdown formatted block_ somewhere in your playground. If your plaground has multiple pages, the first page would be the best location, but you can also add one at the end. playme will replace the line containing `{{GEN:TOC}}` with the TOC contents. \n\n```swift\n/*: This starts a markdown block\n\nThe table of contents will be generated below:\n\n{{GEN:TOC}}\n\nThat's the table of contents.\n*/\n```\n\n\u003e Only one TOC block will be generated, so placing multiple `{{GEN:TOC}}`s will have no effect, only the first one will be considered.\n\n\n### Updates\nRunning playme with `update` will fetch the latest version of the script from GitHub, compare the MD5 hashes of the local vs. downloaded versions of the script and if they found to be different, the local version will be replaced by the GitHub version.\n\n### Anti Credit Union\nDisable appending a credits line at the end by passing in `--no-credits`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenziahamed%2Fplayme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenziahamed%2Fplayme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenziahamed%2Fplayme/lists"}